Skip to content

Commit e6d5beb

Browse files
s-weigands-weigand
committed
added rudimentary docs
1 parent 3904638 commit e6d5beb

24 files changed

+624
-0
lines changed

‎.editorconfig

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 4
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
charset = utf-8
11+
end_of_line = lf
12+
13+
[*.bat]
14+
indent_style = tab
15+
end_of_line = crlf
16+
17+
[LICENSE]
18+
insert_final_newline = false
19+
20+
[Makefile]
21+
indent_style = tab

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,9 @@ pyzipper.egg-info
99
.coverage.*
1010
@test*
1111

12+
# auto generated doc files
13+
docs/api/
14+
docs/_build
15+
1216
# Pycharm project files
1317
.idea/

‎AUTHORS.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* Daniel Hillier <[email protected]>
9+
10+
Contributors
11+
------------
12+
13+
* Sebastian Weigand <[email protected]>

‎CONTRIBUTING.rst

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

‎HISTORY.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
History
3+
=======
4+
5+
0.2.0 (2018-11-17)
6+
------------------
7+
8+
* Second release on PyPI.
9+
10+
0.1.0 (2018-11-07)
11+
------------------
12+
13+
* First release on PyPI.

‎HISTORY.txt

Whitespace-only changes.

‎README.rst

+13
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515
:target: https://ci.appveyor.com/project/danifus/pyzipper/branch/master
1616
:alt: AppVeyor build (Windows)
1717

18+
.. image:: https://readthedocs.org/projects/pyzipper/badge/?version=latest
19+
:target: https://pyzipper.readthedocs.io/en/latest/?badge=latest
20+
:alt: Documentation Status
21+
1822
.. image:: https://coveralls.io/repos/github/danifus/pyzipper/badge.svg?branch=master
1923
:target: https://coveralls.io/github/danifus/pyzipper?branch=master
2024
:alt: Code Coverage
@@ -77,3 +81,12 @@ encryption kwargs:
7781
with pyzipper.AESZipFile('new_test.zip') as zf:
7882
zf.pwd = secret_password
7983
my_secrets = zf.read('test.txt')
84+
85+
86+
Credits
87+
-------
88+
89+
The docs skeleton was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
90+
91+
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
92+
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = python -msphinx
7+
SPHINXPROJ = pyzipper
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/_templates/autosummary/class.rst

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{{ objname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}
6+
7+
{% block attributes_summary %}
8+
{% if attributes %}
9+
10+
.. rubric:: Attributes Summary
11+
12+
.. autosummary::
13+
{% for item in attributes %}
14+
~{{ item }}
15+
{%- endfor %}
16+
17+
{% endif %}
18+
{% endblock %}
19+
20+
{% block methods_summary %}
21+
{% if methods %}
22+
23+
{% if '__init__' in methods %}
24+
{% set caught_result = methods.remove('__init__') %}
25+
{% endif %}
26+
27+
.. rubric:: Methods Summary
28+
29+
.. autosummary::
30+
:toctree: {{ objname }}/methods
31+
:nosignatures:
32+
33+
{% for item in methods %}
34+
~{{ name }}.{{ item }}
35+
{%- endfor %}
36+
37+
{% endif %}
38+
{% endblock %}
39+
40+
{% block methods_documentation %}
41+
{% if methods %}
42+
43+
.. rubric:: Methods Documentation
44+
45+
{% for item in methods %}
46+
.. automethod:: {{ name }}.{{ item }}
47+
{%- endfor %}
48+
49+
{% endif %}
50+
{% endblock %}

‎docs/_templates/autosummary/method.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{{ name | escape | underline }}
2+
3+
.. automethod:: {{ fullname }}
4+
:noindex:

‎docs/authors.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../AUTHORS.rst

0 commit comments

Comments
 (0)