Skip to content

Commit cd4affc

Browse files
wolphwolph
committed
cookiecutter test
1 parent e1b0285 commit cd4affc

11 files changed

Lines changed: 404 additions & 1 deletion

File tree

‎CHANGES‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
=========
2+
Changelog
3+
=========
4+
5+
Here you can find the recent changes to Python Progressbar..
6+
7+
.. changelog::
8+
:version: dev
9+
:released: Ongoing
10+
11+
.. change::
12+
:tags: docs
13+
14+
Updated CHANGES.
15+
16+
.. changelog::
17+
:version: 3.1
18+
:released: 2015-07-11
19+
20+
.. change::
21+
:tags: project
22+
23+
First release on PyPi.
24+
25+
.. todo:: vim: set filetype=rst:

‎CONTRIBUTING.rst‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
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+
You can contribute in many ways:
9+
10+
Types of Contributions
11+
----------------------
12+
13+
Report Bugs
14+
~~~~~~~~~~~
15+
16+
Report bugs at https://github.com/WoLpH/python-progressbar/issues.
17+
18+
If you are reporting a bug, please include:
19+
20+
* Your operating system name and version.
21+
* Any details about your local setup that might be helpful in troubleshooting.
22+
* Detailed steps to reproduce the bug.
23+
24+
Fix Bugs
25+
~~~~~~~~
26+
27+
Look through the GitHub issues for bugs. Anything tagged with "bug"
28+
is open to whoever wants to implement it.
29+
30+
Implement Features
31+
~~~~~~~~~~~~~~~~~~
32+
33+
Look through the GitHub issues for features. Anything tagged with "feature"
34+
is open to whoever wants to implement it.
35+
36+
Write Documentation
37+
~~~~~~~~~~~~~~~~~~~
38+
39+
Python Progressbar could always use more documentation, whether as part of the
40+
official Python Progressbar docs, in docstrings, or even on the web in blog posts,
41+
articles, and such.
42+
43+
Submit Feedback
44+
~~~~~~~~~~~~~~~
45+
46+
The best way to send feedback is to file an issue at https://github.com/WoLpH/python-progressbar/issues.
47+
48+
If you are proposing a feature:
49+
50+
* Explain in detail how it would work.
51+
* Keep the scope as narrow as possible, to make it easier to implement.
52+
* Remember that this is a volunteer-driven project, and that contributions
53+
are welcome :)
54+
55+
Get Started!
56+
------------
57+
58+
Ready to contribute? Here's how to set up `python-progressbar` for local development.
59+
60+
1. Fork the `python-progressbar` repo on GitHub.
61+
2. Clone your fork locally::
62+
63+
$ git clone --branch develop git@github.com:your_name_here/python-progressbar.git
64+
65+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
66+
67+
$ mkvirtualenv python-progressbar
68+
$ cd python-progressbar/
69+
$ pip install -e .
70+
71+
4. Create a branch for local development with `git-flow-avh`_::
72+
73+
$ git-flow feature start name-of-your-bugfix-or-feature
74+
75+
Or without git-flow:
76+
77+
$ git checkout -b feature/name-of-your-bugfix-or-feature
78+
79+
Now you can make your changes locally.
80+
81+
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
82+
83+
$ flake8 python-progressbar tests
84+
$ py.test
85+
$ tox
86+
87+
To get flake8 and tox, just pip install them into your virtualenv using the requirements file.
88+
89+
$ pip install -r tests/requirements.txt
90+
91+
6. Commit your changes and push your branch to GitHub with `git-flow-avh`_::
92+
93+
$ git add .
94+
$ git commit -m "Your detailed description of your changes."
95+
$ git-flow feature publish
96+
97+
Or without git-flow:
98+
99+
$ git add .
100+
$ git commit -m "Your detailed description of your changes."
101+
$ git push -u origin feature/name-of-your-bugfix-or-feature
102+
103+
7. Submit a pull request through the GitHub website.
104+
105+
Pull Request Guidelines
106+
-----------------------
107+
108+
Before you submit a pull request, check that it meets these guidelines:
109+
110+
1. The pull request should include tests.
111+
2. If the pull request adds functionality, the docs should be updated. Put
112+
your new functionality into a function with a docstring, and add the
113+
feature to the list in README.rst.
114+
3. The pull request should work for Python 2.7, 3.3, and for PyPy. Check
115+
https://travis-ci.org/WoLpH/python-progressbar/pull_requests
116+
and make sure that the tests pass for all supported Python versions.
117+
118+
Tips
119+
----
120+
121+
To run a subset of tests::
122+
123+
$ py.test tests/some_test.py
124+
125+
.. _git-flow-avh: https://github.com/petervanderdoes/gitflow
126+

‎LICENSE‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Copyright (c) 2015, Rick van Hattem (Wolph)
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted provided that the following conditions are met:
6+
7+
* Redistributions of source code must retain the above copyright notice, this
8+
list of conditions and the following disclaimer.
9+
10+
* Redistributions in binary form must reproduce the above copyright notice,
11+
this list of conditions and the following disclaimer in the documentation
12+
and/or other materials provided with the distribution.
13+
14+
* Neither the name of Python Progressbar nor the names of its
15+
contributors may be used to endorse or promote products derived from this
16+
software without specific prior written permission.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25+
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26+
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
27+
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28+

‎Makefile‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
.PHONY: clean-pyc clean-build docs
2+
3+
help:
4+
@echo "clean-build - remove build artifacts"
5+
@echo "clean-pyc - remove Python file artifacts"
6+
@echo "lint - check style with flake8"
7+
@echo "test - run tests quickly with the default Python"
8+
@echo "testall - run tests on every Python version with tox"
9+
@echo "coverage - check code coverage quickly with the default Python"
10+
@echo "docs - generate Sphinx HTML documentation, including API docs"
11+
@echo "release - package and upload a release"
12+
@echo "sdist - package"
13+
14+
clean: clean-build clean-pyc
15+
16+
clean-build:
17+
rm -fr build/
18+
rm -fr dist/
19+
rm -fr *.egg-info
20+
21+
clean-pyc:
22+
find . -name '*.pyc' -exec rm -f {} +
23+
find . -name '*.pyo' -exec rm -f {} +
24+
find . -name '*~' -exec rm -f {} +
25+
26+
lint:
27+
flake8 python-progressbar tests
28+
29+
test:
30+
py.test
31+
32+
test-all:
33+
tox
34+
35+
coverage:
36+
coverage run --source python-progressbar setup.py test
37+
coverage report -m
38+
coverage html
39+
open htmlcov/index.html
40+
41+
docs:
42+
rm -f docs/python-progressbar.rst
43+
rm -f docs/modules.rst
44+
sphinx-apidoc -o docs/ python-progressbar
45+
$(MAKE) -C docs clean
46+
$(MAKE) -C docs html
47+
open docs/_build/html/index.html
48+
49+
release: clean
50+
python setup.py register || true
51+
python setup.py sdist upload build_sphinx upload_sphinx
52+
53+
sdist: clean
54+
python setup.py sdist
55+
ls -l dist

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393

9494
# If true, sectionauthor and moduleauthor directives will be shown in the
9595
# output. They are ignored by default.
96-
# show_authors = False
96+
show_authors = True
9797

9898
# The name of the Pygments (syntax highlighting) style to use.
9999
pygments_style = 'sphinx'

‎docs/contributing.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../CONTRIBUTING.rst

‎docs/history.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _history:
2+
3+
=======
4+
History
5+
=======
6+
7+
.. include:: ../CHANGES
8+
:start-line: 5

‎docs/installation.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
============
2+
Installation
3+
============
4+
5+
At the command line::
6+
7+
$ easy_install python-progressbar
8+
9+
Or, if you have virtualenvwrapper installed::
10+
11+
$ mkvirtualenv python-progressbar
12+
$ pip install python-progressbar

‎docs/usage.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
========
2+
Usage
3+
========
4+
5+
To use Python Progressbar in a project::
6+
7+
import python-progressbar

‎progressbar/__about__.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
__title__ = 'Python Progressbar'
2+
__package_name__ = 'progressbar2'
3+
__author__ = 'Rick van Hattem (Wolph)'
4+
__description__ = '''
5+
A Python Progressbar library to provide visual (yet text based) progress to
6+
long running operations.
7+
'''.strip()
8+
__email__ = 'wolph@wol.ph'
9+
__version__ = '3.1'
10+
__license__ = 'BSD'
11+
__copyright__ = 'Copyright 2015 Rick van Hattem (Wolph)'
12+
__url__ = 'https://github.com/WoLpH/python-progressbar'

0 commit comments

Comments
 (0)