Skip to content
This repository was archived by the owner on Jan 22, 2020. It is now read-only.

Commit a5335f9

Browse files
accrazeaccraze
committed
chore: build packaging
1 parent 7446d7e commit a5335f9

28 files changed

+836
-40
lines changed

‎.bumpversion.cfg‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[bumpversion]
2+
current_version = 0.1.0
3+
commit = True
4+
tag = True
5+
6+
[bumpversion:file:setup.py]
7+
8+
[bumpversion:file:docs/conf.py]
9+
10+
[bumpversion:file:src/livingdocs/__init__.py]
11+

‎.cookiecutterrc‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# This file exists so you can easily regenerate your project.
2+
#
3+
# `cookiepatcher` is a convenient shim around `cookiecutter`
4+
# for regenerating projects (it will generate a .cookiecutterrc
5+
# automatically for any template). To use it:
6+
#
7+
# pip install cookiepatcher
8+
# cookiepatcher gh:ionelmc/cookiecutter-pylibrary project-path
9+
#
10+
# See:
11+
# https://pypi.python.org/pypi/cookiecutter
12+
#
13+
# Alternatively, you can run:
14+
#
15+
# cookiecutter --overwrite-if-exists --config-file=project-path/.cookiecutterrc gh:ionelmc/cookiecutter-pylibrary
16+
17+
default_context:
18+
19+
appveyor: 'no'
20+
c_extension_cython: 'no'
21+
c_extension_optional: 'no'
22+
c_extension_support: 'no'
23+
codacy: 'no'
24+
codeclimate: 'no'
25+
codecov: 'yes'
26+
command_line_interface: 'click'
27+
command_line_interface_bin_name: 'livingdocs'
28+
coveralls: 'yes'
29+
distribution_name: 'livingdocs'
30+
email: 'accraze@gmail.com'
31+
full_name: 'Andy Craze'
32+
github_username: 'accraze'
33+
landscape: 'no'
34+
package_name: 'livingdocs'
35+
project_name: 'Living Docs'
36+
project_short_description: 'Create living documentation from BDD specs'
37+
release_date: 'today'
38+
repo_name: 'python-livingdocs'
39+
requiresio: 'no'
40+
scrutinizer: 'no'
41+
sphinx_doctest: 'no'
42+
sphinx_theme: 'sphinx-rtd-theme'
43+
test_matrix_configurator: 'no'
44+
test_matrix_separate_coverage: 'no'
45+
test_runner: 'pytest'
46+
travis: 'yes'
47+
version: '0.1.0'
48+
website: 'https://github.com/accraze'
49+
year: '2016'

‎.coveragerc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[paths]
2+
source =
3+
src/livingdocs
4+
*/site-packages/livingdocs
5+
6+
[run]
7+
branch = true
8+
source =
9+
livingdocs
10+
tests
11+
parallel = true
12+
13+
[report]
14+
show_missing = true
15+
precision = 2
16+
omit = *migrations*

‎.editorconfig‎

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,13 @@
1-
i# EditorConfig http://EditorConfig.org
2-
3-
# top-most EditorConfig file
1+
# see http://editorconfig.org
42
root = true
53

6-
# Unix-style newlines with a newline ending every file
74
[*]
85
end_of_line = lf
6+
trim_trailing_whitespace = true
97
insert_final_newline = true
10-
11-
# Matches multiple files with brace expansion notation
12-
# Set default charset
13-
[*.{js,py}]
14-
charset = utf-8
15-
16-
# 4 space indentation
17-
[*.py]
188
indent_style = space
199
indent_size = 4
10+
charset = utf-8
2011

21-
# Tab indentation (no size specified)
22-
[Makefile]
23-
indent_style = tab
24-
25-
# Indentation override for all JS under lib directory
26-
[static/**.js]
27-
indent_style = space
28-
indent_size = 2
29-
30-
# Matches the exact files either package.json or .travis.yml
31-
[{package.json,.travis.yml}]
32-
indent_style = space
33-
indent_size = 2
12+
[*.{bat,cmd,ps1}]
13+
end_of_line = crlf

‎.gitignore‎

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,64 @@
11
*.py[cod]
2-
env
3-
C extensions
2+
3+
# C extensions
44
*.so
5-
*.swp
5+
66
# Packages
77
*.egg
88
*.egg-info
99
dist
1010
build
1111
eggs
12+
.eggs
1213
parts
1314
bin
1415
var
1516
sdist
17+
wheelhouse
1618
develop-eggs
1719
.installed.cfg
1820
lib
1921
lib64
20-
MANIFEST
22+
venv*/
23+
pyvenv*/
2124

2225
# Installer logs
2326
pip-log.txt
2427

2528
# Unit test / coverage reports
2629
.coverage
2730
.tox
31+
.coverage.*
2832
nosetests.xml
29-
tmp
33+
coverage.xml
34+
htmlcov
3035

3136
# Translations
3237
*.mo
3338

34-
# Code editor
39+
# Mr Developer
40+
.mr.developer.cfg
41+
.project
42+
.pydevproject
43+
.idea
44+
*.iml
45+
*.komodoproject
46+
47+
# Complexity
48+
output/*.html
49+
output/*/index.html
50+
51+
# Sphinx
52+
docs/_build
53+
54+
.DS_Store
3555
*~
36-
*.swp
37-
venv/*
56+
.*.sw[po]
57+
.build
58+
.ve
59+
.env
3860
.cache
39-
.cache/*
61+
.pytest
62+
.bootstrap
63+
.appveyor.token
64+
*.bak

‎.travis.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
language: python
2+
python: '3.5'
3+
sudo: false
4+
env:
5+
global:
6+
- LD_PRELOAD=/lib/x86_64-linux-gnu/libSegFault.so
7+
- SEGFAULT_SIGNALS=all
8+
matrix:
9+
- TOXENV=check
10+
- TOXENV=docs
11+
12+
- TOXENV=py27,coveralls,codecov
13+
- TOXENV=py33,coveralls,codecov
14+
- TOXENV=py34,coveralls,codecov
15+
- TOXENV=py35,coveralls,codecov
16+
- TOXENV=pypy,coveralls,codecov
17+
before_install:
18+
- python --version
19+
- uname -a
20+
- lsb_release -a
21+
install:
22+
- pip install tox
23+
- virtualenv --version
24+
- easy_install --version
25+
- pip --version
26+
- tox --version
27+
script:
28+
- tox -v
29+
after_failure:
30+
- more .tox/log/* | cat
31+
- more .tox/*/log/* | cat
32+
before_cache:
33+
- rm -rf $HOME/.cache/pip/log
34+
cache:
35+
directories:
36+
- $HOME/.cache/pip
37+
notifications:
38+
email:
39+
on_success: never
40+
on_failure: always

‎AUTHORS.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
Authors
3+
=======
4+
5+
* Andy Craze - https://github.com/accraze
6+
* Kevin Lewandowski - https://github.com/kevinsl

‎CHANGELOG.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
Changelog
3+
=========
4+
5+
0.1.0 (2016-08-21)
6+
-----------------------------------------
7+
8+
* First release on PyPI.

‎CONTRIBUTING.rst‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
============
2+
Contributing
3+
============
4+
5+
Contributions are welcome, and they are greatly appreciated! Every
6+
little bit helps, and credit will always be given.
7+
8+
Bug reports
9+
===========
10+
11+
When `reporting a bug <https://github.com/accraze/python-livingdocs/issues>`_ please include:
12+
13+
* Your operating system name and version.
14+
* Any details about your local setup that might be helpful in troubleshooting.
15+
* Detailed steps to reproduce the bug.
16+
17+
Documentation improvements
18+
==========================
19+
20+
Living Docs could always use more documentation, whether as part of the
21+
official Living Docs docs, in docstrings, or even on the web in blog posts,
22+
articles, and such.
23+
24+
Feature requests and feedback
25+
=============================
26+
27+
The best way to send feedback is to file an issue at https://github.com/accraze/python-livingdocs/issues.
28+
29+
If you are proposing a feature:
30+
31+
* Explain in detail how it would work.
32+
* Keep the scope as narrow as possible, to make it easier to implement.
33+
* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
34+
35+
Development
36+
===========
37+
38+
To set up `python-livingdocs` for local development:
39+
40+
1. Fork `python-livingdocs <https://github.com/accraze/python-livingdocs>`_
41+
(look for the "Fork" button).
42+
2. Clone your fork locally::
43+
44+
git clone git@github.com:your_name_here/python-livingdocs.git
45+
46+
3. Create a branch for local development::
47+
48+
git checkout -b name-of-your-bugfix-or-feature
49+
50+
Now you can make your changes locally.
51+
52+
4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.org/en/latest/install.html>`_ one command::
53+
54+
tox
55+
56+
5. Commit your changes and push your branch to GitHub::
57+
58+
git add .
59+
git commit -m "Your detailed description of your changes."
60+
git push origin name-of-your-bugfix-or-feature
61+
62+
6. Submit a pull request through the GitHub website.
63+
64+
Pull Request Guidelines
65+
-----------------------
66+
67+
If you need some code review or feedback while you're developing the code just make the pull request.
68+
69+
For merging, you should:
70+
71+
1. Include passing tests (run ``tox``) [1]_.
72+
2. Update documentation when there's new API, functionality etc.
73+
3. Add a note to ``CHANGELOG.rst`` about the changes.
74+
4. Add yourself to ``AUTHORS.rst``.
75+
76+
.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
77+
`run the tests <https://travis-ci.org/accraze/python-livingdocs/pull_requests>`_ for each change you add in the pull request.
78+
79+
It will be slower though ...
80+
81+
Tips
82+
----
83+
84+
To run a subset of tests::
85+
86+
tox -e envname -- py.test -k test_myfeature
87+
88+
To run all the test environments in *parallel* (you need to ``pip install detox``)::
89+
90+
detox

‎LICENSE‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Copyright (c) 2016, Discogs
2+
3+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
4+
following conditions are met:
5+
6+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
7+
disclaimer.
8+
9+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
10+
disclaimer in the documentation and/or other materials provided with the distribution.
11+
12+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
13+
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
14+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
15+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
16+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
17+
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
18+
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

0 commit comments

Comments
 (0)