Skip to content

Commit a644dcd

Browse files
author
bluepizzey
committedJul 7, 2016
Cookiecutter'd the repo. 0.1.0 release to pypi
·
0.3.00.2.0
1 parent b5d9e66 commit a644dcd

31 files changed

+1919
-21
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

‎.github/ISSUE_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* eridu version:
2+
* Python version:
3+
* Operating System:
4+
5+
### Description
6+
7+
Describe what you were trying to get done.
8+
Tell us what happened, what went wrong, and what you expected to happen.
9+
10+
### What I Did
11+
12+
```
13+
Paste the command(s) you ran and the output.
14+
If there was a crash, please include the traceback here.
15+
```

‎.idea/workspace.xml

+514
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎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+
* Keiron J. Pizzey <kjpizzey@gmail.com>
9+
10+
Contributors
11+
------------
12+
13+
None yet. Why not be the first?

‎CONTRIBUTING.rst

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
.. highlight:: shell
2+
3+
============
4+
Contributing
5+
============
6+
7+
Contributions are welcome, and they are greatly appreciated! Every
8+
little bit 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/sopython/eridu/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"
30+
and "help 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+
eridu could always use more documentation, whether as part of the
42+
official eridu 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/sopython/eridu/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 `eridu` for local development.
61+
62+
1. Fork the `eridu` repo on GitHub.
63+
2. Clone your fork locally::
64+
65+
$ git clone git@github.com:your_name_here/eridu.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 eridu
70+
$ cd eridu/
71+
$ python setup.py develop
72+
73+
4. Create a branch for local development::
74+
75+
$ git checkout -b name-of-your-bugfix-or-feature
76+
77+
Now you can make your changes locally.
78+
79+
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
80+
81+
$ flake8 eridu tests
82+
$ python setup.py test or py.test
83+
$ tox
84+
85+
To get flake8 and tox, just pip install them into your virtualenv.
86+
87+
6. Commit your changes and push your branch to GitHub::
88+
89+
$ git add .
90+
$ git commit -m "Your detailed description of your changes."
91+
$ git push origin name-of-your-bugfix-or-feature
92+
93+
7. Submit a pull request through the GitHub website.
94+
95+
Pull Request Guidelines
96+
-----------------------
97+
98+
Before you submit a pull request, check that it meets these guidelines:
99+
100+
1. The pull request should include tests.
101+
2. If the pull request adds functionality, the docs should be updated. Put
102+
your new functionality into a function with a docstring, and add the
103+
feature to the list in README.rst.
104+
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
105+
https://travis-ci.org/ffisegydd/eridu/pull_requests
106+
and make sure that the tests pass for all supported Python versions.
107+
108+
Tips
109+
----
110+
111+
To run a subset of tests::
112+
113+
114+
$ python -m unittest tests.test_eridu

‎HISTORY.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=======
2+
History
3+
=======
4+
5+
0.1.0 (2016-07-07)
6+
------------------
7+
8+
* First release on PyPI.

‎LICENSE

+23-19
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
1-
Copyright (c) 2016, sopython
1+
2+
BSD License
3+
4+
Copyright (c) 2016, Keiron J. Pizzey
25
All rights reserved.
36

4-
Redistribution and use in source and binary forms, with or without
5-
modification, are permitted provided that the following conditions are met:
7+
Redistribution and use in source and binary forms, with or without modification,
8+
are permitted provided that the following conditions are met:
69

710
* Redistributions of source code must retain the above copyright notice, this
811
list of conditions and the following disclaimer.
912

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+
* Redistributions in binary form must reproduce the above copyright notice, this
14+
list of conditions and the following disclaimer in the documentation and/or
15+
other materials provided with the distribution.
1316

1417
* Neither the name of eridu nor the names of its
15-
contributors may be used to endorse or promote products derived from
16-
this software without specific prior written permission.
17-
18-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20-
IMPLIED 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) HOWEVER
25-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
18+
contributors may be used to endorse or promote products derived from this
19+
software without specific prior written permission.
20+
21+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
22+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24+
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25+
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26+
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
28+
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29+
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
30+
OF THE POSSIBILITY OF SUCH DAMAGE.
31+

‎MANIFEST.in

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
include AUTHORS.rst
2+
include CONTRIBUTING.rst
3+
include HISTORY.rst
4+
include LICENSE
5+
include README.rst
6+
7+
recursive-include tests *
8+
recursive-exclude * __pycache__
9+
recursive-exclude * *.py[co]
10+
11+
recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

‎Makefile

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
.PHONY: clean clean-test clean-pyc clean-build docs help
2+
.DEFAULT_GOAL := help
3+
define BROWSER_PYSCRIPT
4+
import os, webbrowser, sys
5+
try:
6+
from urllib import pathname2url
7+
except:
8+
from urllib.request import pathname2url
9+
10+
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
11+
endef
12+
export BROWSER_PYSCRIPT
13+
14+
define PRINT_HELP_PYSCRIPT
15+
import re, sys
16+
17+
for line in sys.stdin:
18+
match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
19+
if match:
20+
target, help = match.groups()
21+
print("%-20s %s" % (target, help))
22+
endef
23+
export PRINT_HELP_PYSCRIPT
24+
BROWSER := python -c "$$BROWSER_PYSCRIPT"
25+
26+
help:
27+
@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
28+
29+
clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
30+
31+
32+
clean-build: ## remove build artifacts
33+
rm -fr build/
34+
rm -fr dist/
35+
rm -fr .eggs/
36+
find . -name '*.egg-info' -exec rm -fr {} +
37+
find . -name '*.egg' -exec rm -f {} +
38+
39+
clean-pyc: ## remove Python file artifacts
40+
find . -name '*.pyc' -exec rm -f {} +
41+
find . -name '*.pyo' -exec rm -f {} +
42+
find . -name '*~' -exec rm -f {} +
43+
find . -name '__pycache__' -exec rm -fr {} +
44+
45+
clean-test: ## remove test and coverage artifacts
46+
rm -fr .tox/
47+
rm -f .coverage
48+
rm -fr htmlcov/
49+
50+
lint: ## check style with flake8
51+
flake8 eridu tests
52+
53+
test: ## run tests quickly with the default Python
54+
55+
python setup.py test
56+
57+
test-all: ## run tests on every Python version with tox
58+
tox
59+
60+
coverage: ## check code coverage quickly with the default Python
61+
62+
coverage run --source eridu setup.py test
63+
64+
coverage report -m
65+
coverage html
66+
$(BROWSER) htmlcov/index.html
67+
68+
docs: ## generate Sphinx HTML documentation, including API docs
69+
rm -f docs/eridu.rst
70+
rm -f docs/modules.rst
71+
sphinx-apidoc -o docs/ eridu
72+
$(MAKE) -C docs clean
73+
$(MAKE) -C docs html
74+
$(BROWSER) docs/_build/html/index.html
75+
76+
servedocs: docs ## compile the docs watching for changes
77+
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
78+
79+
release: clean ## package and upload a release
80+
python setup.py sdist upload
81+
python setup.py bdist_wheel upload
82+
83+
dist: clean ## builds source and wheel package
84+
python setup.py sdist
85+
python setup.py bdist_wheel
86+
ls -l dist
87+
88+
install: clean ## install the package to the active Python's site-packages
89+
python setup.py install

‎README.md

-2
This file was deleted.

‎README.rst

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
===============================
2+
eridu
3+
===============================
4+
5+
6+
.. image:: https://img.shields.io/pypi/v/eridu.svg
7+
:target: https://pypi.python.org/pypi/eridu
8+
9+
.. image:: https://img.shields.io/travis/ffisegydd/eridu.svg
10+
:target: https://travis-ci.org/ffisegydd/eridu
11+
12+
.. image:: https://readthedocs.org/projects/eridu/badge/?version=latest
13+
:target: https://eridu.readthedocs.io/en/latest/?badge=latest
14+
:alt: Documentation Status
15+
16+
.. image:: https://pyup.io/repos/github/ffisegydd/eridu/shield.svg
17+
:target: https://pyup.io/repos/github/ffisegydd/eridu/
18+
:alt: Updates
19+
20+
21+
Project Cradle library for accessing historic SO content.
22+
23+
24+
* Free software: BSD license
25+
* Documentation: https://eridu.readthedocs.io.
26+
27+
28+
Features
29+
--------
30+
31+
* TODO
32+
33+
Credits
34+
---------
35+
36+
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
37+
38+
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
39+
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
40+

‎docs/Makefile

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = _build
9+
10+
# User-friendly check for sphinx-build
11+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13+
endif
14+
15+
# Internal variables.
16+
PAPEROPT_a4 = -D latex_paper_size=a4
17+
PAPEROPT_letter = -D latex_paper_size=letter
18+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19+
# the i18n builder cannot share the environment and doctrees with the others
20+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21+
22+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23+
24+
help:
25+
@echo "Please use \`make <target>' where <target> is one of"
26+
@echo " html to make standalone HTML files"
27+
@echo " dirhtml to make HTML files named index.html in directories"
28+
@echo " singlehtml to make a single large HTML file"
29+
@echo " pickle to make pickle files"
30+
@echo " json to make JSON files"
31+
@echo " htmlhelp to make HTML files and a HTML help project"
32+
@echo " qthelp to make HTML files and a qthelp project"
33+
@echo " devhelp to make HTML files and a Devhelp project"
34+
@echo " epub to make an epub"
35+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
37+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38+
@echo " text to make text files"
39+
@echo " man to make manual pages"
40+
@echo " texinfo to make Texinfo files"
41+
@echo " info to make Texinfo files and run them through makeinfo"
42+
@echo " gettext to make PO message catalogs"
43+
@echo " changes to make an overview of all changed/added/deprecated items"
44+
@echo " xml to make Docutils-native XML files"
45+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
46+
@echo " linkcheck to check all external links for integrity"
47+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
48+
49+
clean:
50+
rm -rf $(BUILDDIR)/*
51+
52+
html:
53+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54+
@echo
55+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56+
57+
dirhtml:
58+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59+
@echo
60+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61+
62+
singlehtml:
63+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64+
@echo
65+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66+
67+
pickle:
68+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69+
@echo
70+
@echo "Build finished; now you can process the pickle files."
71+
72+
json:
73+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74+
@echo
75+
@echo "Build finished; now you can process the JSON files."
76+
77+
htmlhelp:
78+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79+
@echo
80+
@echo "Build finished; now you can run HTML Help Workshop with the" \
81+
".hhp project file in $(BUILDDIR)/htmlhelp."
82+
83+
qthelp:
84+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85+
@echo
86+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
87+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/eridu.qhcp"
89+
@echo "To view the help file:"
90+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/eridu.qhc"
91+
92+
devhelp:
93+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94+
@echo
95+
@echo "Build finished."
96+
@echo "To view the help file:"
97+
@echo "# mkdir -p $$HOME/.local/share/devhelp/eridu"
98+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/eridu"
99+
@echo "# devhelp"
100+
101+
epub:
102+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103+
@echo
104+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105+
106+
latex:
107+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108+
@echo
109+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
111+
"(use \`make latexpdf' here to do that automatically)."
112+
113+
latexpdf:
114+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115+
@echo "Running LaTeX files through pdflatex..."
116+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
117+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118+
119+
latexpdfja:
120+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121+
@echo "Running LaTeX files through platex and dvipdfmx..."
122+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124+
125+
text:
126+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127+
@echo
128+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
129+
130+
man:
131+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132+
@echo
133+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134+
135+
texinfo:
136+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137+
@echo
138+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139+
@echo "Run \`make' in that directory to run these through makeinfo" \
140+
"(use \`make info' here to do that automatically)."
141+
142+
info:
143+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144+
@echo "Running Texinfo files through makeinfo..."
145+
make -C $(BUILDDIR)/texinfo info
146+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147+
148+
gettext:
149+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150+
@echo
151+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152+
153+
changes:
154+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155+
@echo
156+
@echo "The overview file is in $(BUILDDIR)/changes."
157+
158+
linkcheck:
159+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160+
@echo
161+
@echo "Link check complete; look for any errors in the above output " \
162+
"or in $(BUILDDIR)/linkcheck/output.txt."
163+
164+
doctest:
165+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166+
@echo "Testing of doctests in the sources finished, look at the " \
167+
"results in $(BUILDDIR)/doctest/output.txt."
168+
169+
xml:
170+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171+
@echo
172+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173+
174+
pseudoxml:
175+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176+
@echo
177+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

‎docs/authors.rst

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

‎docs/conf.py

+275
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,275 @@
1+
#!/usr/bin/env python
2+
# -*- coding: utf-8 -*-
3+
#
4+
# eridu documentation build configuration file, created by
5+
# sphinx-quickstart on Tue Jul 9 22:26:36 2013.
6+
#
7+
# This file is execfile()d with the current directory set to its
8+
# containing dir.
9+
#
10+
# Note that not all possible configuration values are present in this
11+
# autogenerated file.
12+
#
13+
# All configuration values have a default; values that are commented out
14+
# serve to show the default.
15+
16+
import sys
17+
import os
18+
19+
# If extensions (or modules to document with autodoc) are in another
20+
# directory, add these directories to sys.path here. If the directory is
21+
# relative to the documentation root, use os.path.abspath to make it
22+
# absolute, like shown here.
23+
#sys.path.insert(0, os.path.abspath('.'))
24+
25+
# Get the project root dir, which is the parent dir of this
26+
cwd = os.getcwd()
27+
project_root = os.path.dirname(cwd)
28+
29+
# Insert the project root dir as the first element in the PYTHONPATH.
30+
# This lets us ensure that the source package is imported, and that its
31+
# version is used.
32+
sys.path.insert(0, project_root)
33+
34+
import eridu
35+
36+
# -- General configuration ---------------------------------------------
37+
38+
# If your documentation needs a minimal Sphinx version, state it here.
39+
#needs_sphinx = '1.0'
40+
41+
# Add any Sphinx extension module names here, as strings. They can be
42+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
43+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
44+
45+
# Add any paths that contain templates here, relative to this directory.
46+
templates_path = ['_templates']
47+
48+
# The suffix of source filenames.
49+
source_suffix = '.rst'
50+
51+
# The encoding of source files.
52+
#source_encoding = 'utf-8-sig'
53+
54+
# The master toctree document.
55+
master_doc = 'index'
56+
57+
# General information about the project.
58+
project = u'eridu'
59+
copyright = u"2016, Keiron J. Pizzey"
60+
61+
# The version info for the project you're documenting, acts as replacement
62+
# for |version| and |release|, also used in various other places throughout
63+
# the built documents.
64+
#
65+
# The short X.Y version.
66+
version = eridu.__version__
67+
# The full version, including alpha/beta/rc tags.
68+
release = eridu.__version__
69+
70+
# The language for content autogenerated by Sphinx. Refer to documentation
71+
# for a list of supported languages.
72+
#language = None
73+
74+
# There are two options for replacing |today|: either, you set today to
75+
# some non-false value, then it is used:
76+
#today = ''
77+
# Else, today_fmt is used as the format for a strftime call.
78+
#today_fmt = '%B %d, %Y'
79+
80+
# List of patterns, relative to source directory, that match files and
81+
# directories to ignore when looking for source files.
82+
exclude_patterns = ['_build']
83+
84+
# The reST default role (used for this markup: `text`) to use for all
85+
# documents.
86+
#default_role = None
87+
88+
# If true, '()' will be appended to :func: etc. cross-reference text.
89+
#add_function_parentheses = True
90+
91+
# If true, the current module name will be prepended to all description
92+
# unit titles (such as .. function::).
93+
#add_module_names = True
94+
95+
# If true, sectionauthor and moduleauthor directives will be shown in the
96+
# output. They are ignored by default.
97+
#show_authors = False
98+
99+
# The name of the Pygments (syntax highlighting) style to use.
100+
pygments_style = 'sphinx'
101+
102+
# A list of ignored prefixes for module index sorting.
103+
#modindex_common_prefix = []
104+
105+
# If true, keep warnings as "system message" paragraphs in the built
106+
# documents.
107+
#keep_warnings = False
108+
109+
110+
# -- Options for HTML output -------------------------------------------
111+
112+
# The theme to use for HTML and HTML Help pages. See the documentation for
113+
# a list of builtin themes.
114+
html_theme = 'default'
115+
116+
# Theme options are theme-specific and customize the look and feel of a
117+
# theme further. For a list of options available for each theme, see the
118+
# documentation.
119+
#html_theme_options = {}
120+
121+
# Add any paths that contain custom themes here, relative to this directory.
122+
#html_theme_path = []
123+
124+
# The name for this set of Sphinx documents. If None, it defaults to
125+
# "<project> v<release> documentation".
126+
#html_title = None
127+
128+
# A shorter title for the navigation bar. Default is the same as
129+
# html_title.
130+
#html_short_title = None
131+
132+
# The name of an image file (relative to this directory) to place at the
133+
# top of the sidebar.
134+
#html_logo = None
135+
136+
# The name of an image file (within the static path) to use as favicon
137+
# of the docs. This file should be a Windows icon file (.ico) being
138+
# 16x16 or 32x32 pixels large.
139+
#html_favicon = None
140+
141+
# Add any paths that contain custom static files (such as style sheets)
142+
# here, relative to this directory. They are copied after the builtin
143+
# static files, so a file named "default.css" will overwrite the builtin
144+
# "default.css".
145+
html_static_path = ['_static']
146+
147+
# If not '', a 'Last updated on:' timestamp is inserted at every page
148+
# bottom, using the given strftime format.
149+
#html_last_updated_fmt = '%b %d, %Y'
150+
151+
# If true, SmartyPants will be used to convert quotes and dashes to
152+
# typographically correct entities.
153+
#html_use_smartypants = True
154+
155+
# Custom sidebar templates, maps document names to template names.
156+
#html_sidebars = {}
157+
158+
# Additional templates that should be rendered to pages, maps page names
159+
# to template names.
160+
#html_additional_pages = {}
161+
162+
# If false, no module index is generated.
163+
#html_domain_indices = True
164+
165+
# If false, no index is generated.
166+
#html_use_index = True
167+
168+
# If true, the index is split into individual pages for each letter.
169+
#html_split_index = False
170+
171+
# If true, links to the reST sources are added to the pages.
172+
#html_show_sourcelink = True
173+
174+
# If true, "Created using Sphinx" is shown in the HTML footer.
175+
# Default is True.
176+
#html_show_sphinx = True
177+
178+
# If true, "(C) Copyright ..." is shown in the HTML footer.
179+
# Default is True.
180+
#html_show_copyright = True
181+
182+
# If true, an OpenSearch description file will be output, and all pages
183+
# will contain a <link> tag referring to it. The value of this option
184+
# must be the base URL from which the finished HTML is served.
185+
#html_use_opensearch = ''
186+
187+
# This is the file name suffix for HTML files (e.g. ".xhtml").
188+
#html_file_suffix = None
189+
190+
# Output file base name for HTML help builder.
191+
htmlhelp_basename = 'eridudoc'
192+
193+
194+
# -- Options for LaTeX output ------------------------------------------
195+
196+
latex_elements = {
197+
# The paper size ('letterpaper' or 'a4paper').
198+
#'papersize': 'letterpaper',
199+
200+
# The font size ('10pt', '11pt' or '12pt').
201+
#'pointsize': '10pt',
202+
203+
# Additional stuff for the LaTeX preamble.
204+
#'preamble': '',
205+
}
206+
207+
# Grouping the document tree into LaTeX files. List of tuples
208+
# (source start file, target name, title, author, documentclass
209+
# [howto/manual]).
210+
latex_documents = [
211+
('index', 'eridu.tex',
212+
u'eridu Documentation',
213+
u'Keiron J. Pizzey', 'manual'),
214+
]
215+
216+
# The name of an image file (relative to this directory) to place at
217+
# the top of the title page.
218+
#latex_logo = None
219+
220+
# For "manual" documents, if this is true, then toplevel headings
221+
# are parts, not chapters.
222+
#latex_use_parts = False
223+
224+
# If true, show page references after internal links.
225+
#latex_show_pagerefs = False
226+
227+
# If true, show URL addresses after external links.
228+
#latex_show_urls = False
229+
230+
# Documents to append as an appendix to all manuals.
231+
#latex_appendices = []
232+
233+
# If false, no module index is generated.
234+
#latex_domain_indices = True
235+
236+
237+
# -- Options for manual page output ------------------------------------
238+
239+
# One entry per manual page. List of tuples
240+
# (source start file, name, description, authors, manual section).
241+
man_pages = [
242+
('index', 'eridu',
243+
u'eridu Documentation',
244+
[u'Keiron J. Pizzey'], 1)
245+
]
246+
247+
# If true, show URL addresses after external links.
248+
#man_show_urls = False
249+
250+
251+
# -- Options for Texinfo output ----------------------------------------
252+
253+
# Grouping the document tree into Texinfo files. List of tuples
254+
# (source start file, target name, title, author,
255+
# dir menu entry, description, category)
256+
texinfo_documents = [
257+
('index', 'eridu',
258+
u'eridu Documentation',
259+
u'Keiron J. Pizzey',
260+
'eridu',
261+
'One line description of project.',
262+
'Miscellaneous'),
263+
]
264+
265+
# Documents to append as an appendix to all manuals.
266+
#texinfo_appendices = []
267+
268+
# If false, no module index is generated.
269+
#texinfo_domain_indices = True
270+
271+
# How to display URL addresses: 'footnote', 'no', or 'inline'.
272+
#texinfo_show_urls = 'footnote'
273+
274+
# If true, do not generate a @detailmenu in the "Top" node's menu.
275+
#texinfo_no_detailmenu = False

‎docs/contributing.rst

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

‎docs/history.rst

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

‎docs/index.rst

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. eridu documentation master file, created by
2+
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to eridu's documentation!
7+
======================================
8+
9+
Contents:
10+
11+
.. toctree::
12+
:maxdepth: 2
13+
14+
readme
15+
installation
16+
usage
17+
contributing
18+
authorshistory
19+
20+
Indices and tables
21+
==================
22+
23+
* :ref:`genindex`
24+
* :ref:`modindex`
25+
* :ref:`search`

‎docs/installation.rst

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. highlight:: shell
2+
3+
============
4+
Installation
5+
============
6+
7+
8+
Stable release
9+
--------------
10+
11+
To install eridu, run this command in your terminal:
12+
13+
.. code-block:: console
14+
15+
$ pip install eridu
16+
17+
This is the preferred method to install eridu, as it will always install the most recent stable release.
18+
19+
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
20+
you through the process.
21+
22+
.. _pip: https://pip.pypa.io
23+
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
24+
25+
26+
From sources
27+
------------
28+
29+
The sources for eridu can be downloaded from the `Github repo`_.
30+
31+
You can either clone the public repository:
32+
33+
.. code-block:: console
34+
35+
$ git clone git://github.com/ffisegydd/eridu
36+
37+
Or download the `tarball`_:
38+
39+
.. code-block:: console
40+
41+
$ curl -OL https://github.com/ffisegydd/eridu/tarball/master
42+
43+
Once you have a copy of the source, you can install it with:
44+
45+
.. code-block:: console
46+
47+
$ python setup.py install
48+
49+
50+
.. _Github repo: https://github.com/ffisegydd/eridu
51+
.. _tarball: https://github.com/ffisegydd/eridu/tarball/master

‎docs/make.bat

+242
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
@ECHO OFF
2+
3+
REM Command file for Sphinx documentation
4+
5+
if "%SPHINXBUILD%" == "" (
6+
set SPHINXBUILD=sphinx-build
7+
)
8+
set BUILDDIR=_build
9+
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10+
set I18NSPHINXOPTS=%SPHINXOPTS% .
11+
if NOT "%PAPER%" == "" (
12+
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13+
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14+
)
15+
16+
if "%1" == "" goto help
17+
18+
if "%1" == "help" (
19+
:help
20+
echo.Please use `make ^<target^>` where ^<target^> is one of
21+
echo. html to make standalone HTML files
22+
echo. dirhtml to make HTML files named index.html in directories
23+
echo. singlehtml to make a single large HTML file
24+
echo. pickle to make pickle files
25+
echo. json to make JSON files
26+
echo. htmlhelp to make HTML files and a HTML help project
27+
echo. qthelp to make HTML files and a qthelp project
28+
echo. devhelp to make HTML files and a Devhelp project
29+
echo. epub to make an epub
30+
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31+
echo. text to make text files
32+
echo. man to make manual pages
33+
echo. texinfo to make Texinfo files
34+
echo. gettext to make PO message catalogs
35+
echo. changes to make an overview over all changed/added/deprecated items
36+
echo. xml to make Docutils-native XML files
37+
echo. pseudoxml to make pseudoxml-XML files for display purposes
38+
echo. linkcheck to check all external links for integrity
39+
echo. doctest to run all doctests embedded in the documentation if enabled
40+
goto end
41+
)
42+
43+
if "%1" == "clean" (
44+
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
45+
del /q /s %BUILDDIR%\*
46+
goto end
47+
)
48+
49+
50+
%SPHINXBUILD% 2> nul
51+
if errorlevel 9009 (
52+
echo.
53+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
54+
echo.installed, then set the SPHINXBUILD environment variable to point
55+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
56+
echo.may add the Sphinx directory to PATH.
57+
echo.
58+
echo.If you don't have Sphinx installed, grab it from
59+
echo.http://sphinx-doc.org/
60+
exit /b 1
61+
)
62+
63+
if "%1" == "html" (
64+
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
65+
if errorlevel 1 exit /b 1
66+
echo.
67+
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
68+
goto end
69+
)
70+
71+
if "%1" == "dirhtml" (
72+
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
73+
if errorlevel 1 exit /b 1
74+
echo.
75+
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
76+
goto end
77+
)
78+
79+
if "%1" == "singlehtml" (
80+
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
81+
if errorlevel 1 exit /b 1
82+
echo.
83+
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
84+
goto end
85+
)
86+
87+
if "%1" == "pickle" (
88+
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
89+
if errorlevel 1 exit /b 1
90+
echo.
91+
echo.Build finished; now you can process the pickle files.
92+
goto end
93+
)
94+
95+
if "%1" == "json" (
96+
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
97+
if errorlevel 1 exit /b 1
98+
echo.
99+
echo.Build finished; now you can process the JSON files.
100+
goto end
101+
)
102+
103+
if "%1" == "htmlhelp" (
104+
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
105+
if errorlevel 1 exit /b 1
106+
echo.
107+
echo.Build finished; now you can run HTML Help Workshop with the ^
108+
.hhp project file in %BUILDDIR%/htmlhelp.
109+
goto end
110+
)
111+
112+
if "%1" == "qthelp" (
113+
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
114+
if errorlevel 1 exit /b 1
115+
echo.
116+
echo.Build finished; now you can run "qcollectiongenerator" with the ^
117+
.qhcp project file in %BUILDDIR%/qthelp, like this:
118+
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\eridu.qhcp
119+
echo.To view the help file:
120+
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\eridu.ghc
121+
goto end
122+
)
123+
124+
if "%1" == "devhelp" (
125+
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
126+
if errorlevel 1 exit /b 1
127+
echo.
128+
echo.Build finished.
129+
goto end
130+
)
131+
132+
if "%1" == "epub" (
133+
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
134+
if errorlevel 1 exit /b 1
135+
echo.
136+
echo.Build finished. The epub file is in %BUILDDIR%/epub.
137+
goto end
138+
)
139+
140+
if "%1" == "latex" (
141+
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
142+
if errorlevel 1 exit /b 1
143+
echo.
144+
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
145+
goto end
146+
)
147+
148+
if "%1" == "latexpdf" (
149+
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
150+
cd %BUILDDIR%/latex
151+
make all-pdf
152+
cd %BUILDDIR%/..
153+
echo.
154+
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
155+
goto end
156+
)
157+
158+
if "%1" == "latexpdfja" (
159+
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
160+
cd %BUILDDIR%/latex
161+
make all-pdf-ja
162+
cd %BUILDDIR%/..
163+
echo.
164+
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
165+
goto end
166+
)
167+
168+
if "%1" == "text" (
169+
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
170+
if errorlevel 1 exit /b 1
171+
echo.
172+
echo.Build finished. The text files are in %BUILDDIR%/text.
173+
goto end
174+
)
175+
176+
if "%1" == "man" (
177+
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
178+
if errorlevel 1 exit /b 1
179+
echo.
180+
echo.Build finished. The manual pages are in %BUILDDIR%/man.
181+
goto end
182+
)
183+
184+
if "%1" == "texinfo" (
185+
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
186+
if errorlevel 1 exit /b 1
187+
echo.
188+
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
189+
goto end
190+
)
191+
192+
if "%1" == "gettext" (
193+
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
194+
if errorlevel 1 exit /b 1
195+
echo.
196+
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
197+
goto end
198+
)
199+
200+
if "%1" == "changes" (
201+
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
202+
if errorlevel 1 exit /b 1
203+
echo.
204+
echo.The overview file is in %BUILDDIR%/changes.
205+
goto end
206+
)
207+
208+
if "%1" == "linkcheck" (
209+
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
210+
if errorlevel 1 exit /b 1
211+
echo.
212+
echo.Link check complete; look for any errors in the above output ^
213+
or in %BUILDDIR%/linkcheck/output.txt.
214+
goto end
215+
)
216+
217+
if "%1" == "doctest" (
218+
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
219+
if errorlevel 1 exit /b 1
220+
echo.
221+
echo.Testing of doctests in the sources finished, look at the ^
222+
results in %BUILDDIR%/doctest/output.txt.
223+
goto end
224+
)
225+
226+
if "%1" == "xml" (
227+
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
228+
if errorlevel 1 exit /b 1
229+
echo.
230+
echo.Build finished. The XML files are in %BUILDDIR%/xml.
231+
goto end
232+
)
233+
234+
if "%1" == "pseudoxml" (
235+
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
236+
if errorlevel 1 exit /b 1
237+
echo.
238+
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
239+
goto end
240+
)
241+
242+
:end

‎docs/readme.rst

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

‎docs/usage.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
=====
2+
Usage
3+
=====
4+
5+
To use eridu in a project::
6+
7+
import eridu

‎eridu/__init__.py

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# -*- coding: utf-8 -*-
2+
3+
__author__ = 'Keiron J. Pizzey'
4+
__email__ = 'kjpizzey@gmail.com'
5+
__version__ = '0.1.0'

‎eridu/cli.py

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# -*- coding: utf-8 -*-
2+
3+
import click
4+
5+
@click.command()
6+
def main(args=None):
7+
"""Console script for eridu"""
8+
click.echo("Replace this message by putting your code into "
9+
"eridu.cli.main")
10+
click.echo("See click documentation at http://click.pocoo.org/")
11+
12+
13+
if __name__ == "__main__":
14+
main()

‎eridu/eridu.py

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# -*- coding: utf-8 -*-

‎requirements_dev.txt

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
pip==8.1.2
2+
bumpversion==0.5.3
3+
wheel==0.29.0
4+
watchdog==0.8.3
5+
flake8==2.6.0
6+
tox==2.3.1
7+
coverage==4.1
8+
Sphinx==1.4.4
9+
cryptography==1.4
10+
PyYAML==3.11
11+

‎setup.cfg

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[bumpversion]
2+
current_version = 0.1.0
3+
commit = True
4+
tag = True
5+
6+
[bumpversion:file:setup.py]
7+
search = version='{current_version}'
8+
replace = version='{new_version}'
9+
10+
[bumpversion:file:eridu/__init__.py]
11+
search = __version__ = '{current_version}'
12+
replace = __version__ = '{new_version}'
13+
14+
[wheel]
15+
universal = 1
16+
17+
[flake8]
18+
exclude = docs

‎setup.py

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
#!/usr/bin/env python
2+
# -*- coding: utf-8 -*-
3+
4+
from setuptools import setup
5+
6+
with open('README.rst') as readme_file:
7+
readme = readme_file.read()
8+
9+
with open('HISTORY.rst') as history_file:
10+
history = history_file.read()
11+
12+
requirements = [
13+
'Click>=6.0',
14+
# TODO: put package requirements here
15+
]
16+
17+
test_requirements = [
18+
# TODO: put package test requirements here
19+
]
20+
21+
setup(
22+
name='sopython-eridu',
23+
version='0.1.0',
24+
description="Project Cradle library for accessing historic SO content.",
25+
long_description=readme + '\n\n' + history,
26+
author="Keiron J. Pizzey",
27+
author_email='kjpizzey@gmail.com',
28+
url='https://github.com/ffisegydd/eridu',
29+
packages=[
30+
'eridu',
31+
],
32+
package_dir={'eridu':
33+
'eridu'},
34+
entry_points={
35+
'console_scripts': [
36+
'eridu=eridu.cli:main'
37+
]
38+
},
39+
include_package_data=True,
40+
install_requires=requirements,
41+
license="BSD license",
42+
zip_safe=False,
43+
keywords='eridu',
44+
classifiers=[
45+
'Development Status :: 2 - Pre-Alpha',
46+
'Intended Audience :: Developers',
47+
'License :: OSI Approved :: BSD License',
48+
'Natural Language :: English',
49+
'Programming Language :: Python :: 3',
50+
'Programming Language :: Python :: 3.3',
51+
'Programming Language :: Python :: 3.4',
52+
'Programming Language :: Python :: 3.5',
53+
],
54+
test_suite='tests',
55+
tests_require=test_requirements
56+
)

‎tests/__init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# -*- coding: utf-8 -*-

‎tests/test_eridu.py

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
#!/usr/bin/env python
2+
# -*- coding: utf-8 -*-
3+
4+
"""
5+
test_eridu
6+
----------------------------------
7+
8+
Tests for `eridu` module.
9+
"""
10+
11+
12+
import sys
13+
import unittest
14+
from contextlib import contextmanager
15+
from click.testing import CliRunner
16+
17+
from eridu import eridu
18+
from eridu import cli
19+
20+
21+
22+
class TestEridu(unittest.TestCase):
23+
24+
def setUp(self):
25+
pass
26+
27+
def tearDown(self):
28+
pass
29+
30+
def test_000_something(self):
31+
pass
32+
33+
def test_command_line_interface(self):
34+
runner = CliRunner()
35+
result = runner.invoke(cli.main)
36+
assert result.exit_code == 0
37+
assert 'eridu.cli.main' in result.output
38+
help_result = runner.invoke(cli.main, ['--help'])
39+
assert help_result.exit_code == 0
40+
assert '--help Show this message and exit.' in help_result.output
41+
42+
43+
if __name__ == '__main__':
44+
sys.exit(unittest.main())

‎tox.ini

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[tox]
2+
envlist = py26, py27, py33, py34, py35, flake8
3+
4+
[testenv:flake8]
5+
basepython=python
6+
deps=flake8
7+
commands=flake8 eridu
8+
9+
[testenv]
10+
setenv =
11+
PYTHONPATH = {toxinidir}:{toxinidir}/eridu
12+
13+
commands = python setup.py test
14+
15+
; If you want to make tox run the tests with the same versions, create a
16+
; requirements.txt with the pinned versions and uncomment the following lines:
17+
; deps =
18+
; -r{toxinidir}/requirements.txt

‎travis_pypi_setup.py

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
#!/usr/bin/env python
2+
# -*- coding: utf-8 -*-
3+
"""Update encrypted deploy password in Travis config file
4+
"""
5+
6+
7+
from __future__ import print_function
8+
import base64
9+
import json
10+
import os
11+
from getpass import getpass
12+
import yaml
13+
from cryptography.hazmat.primitives.serialization import load_pem_public_key
14+
from cryptography.hazmat.backends import default_backend
15+
from cryptography.hazmat.primitives.asymmetric.padding import PKCS1v15
16+
17+
18+
try:
19+
from urllib import urlopen
20+
except:
21+
from urllib.request import urlopen
22+
23+
24+
GITHUB_REPO = 'ffisegydd/eridu'
25+
TRAVIS_CONFIG_FILE = os.path.join(
26+
os.path.dirname(os.path.abspath(__file__)), '.travis.yml')
27+
28+
29+
def load_key(pubkey):
30+
"""Load public RSA key, with work-around for keys using
31+
incorrect header/footer format.
32+
33+
Read more about RSA encryption with cryptography:
34+
https://cryptography.io/latest/hazmat/primitives/asymmetric/rsa/
35+
"""
36+
try:
37+
return load_pem_public_key(pubkey.encode(), default_backend())
38+
except ValueError:
39+
# workaround for https://github.com/travis-ci/travis-api/issues/196
40+
pubkey = pubkey.replace('BEGIN RSA', 'BEGIN').replace('END RSA', 'END')
41+
return load_pem_public_key(pubkey.encode(), default_backend())
42+
43+
44+
def encrypt(pubkey, password):
45+
"""Encrypt password using given RSA public key and encode it with base64.
46+
47+
The encrypted password can only be decrypted by someone with the
48+
private key (in this case, only Travis).
49+
"""
50+
key = load_key(pubkey)
51+
encrypted_password = key.encrypt(password, PKCS1v15())
52+
return base64.b64encode(encrypted_password)
53+
54+
55+
def fetch_public_key(repo):
56+
"""Download RSA public key Travis will use for this repo.
57+
58+
Travis API docs: http://docs.travis-ci.com/api/#repository-keys
59+
"""
60+
keyurl = 'https://api.travis-ci.org/repos/{0}/key'.format(repo)
61+
data = json.loads(urlopen(keyurl).read().decode())
62+
if 'key' not in data:
63+
errmsg = "Could not find public key for repo: {}.\n".format(repo)
64+
errmsg += "Have you already added your GitHub repo to Travis?"
65+
raise ValueError(errmsg)
66+
return data['key']
67+
68+
69+
def prepend_line(filepath, line):
70+
"""Rewrite a file adding a line to its beginning.
71+
"""
72+
with open(filepath) as f:
73+
lines = f.readlines()
74+
75+
lines.insert(0, line)
76+
77+
with open(filepath, 'w') as f:
78+
f.writelines(lines)
79+
80+
81+
def load_yaml_config(filepath):
82+
with open(filepath) as f:
83+
return yaml.load(f)
84+
85+
86+
def save_yaml_config(filepath, config):
87+
with open(filepath, 'w') as f:
88+
yaml.dump(config, f, default_flow_style=False)
89+
90+
91+
def update_travis_deploy_password(encrypted_password):
92+
"""Update the deploy section of the .travis.yml file
93+
to use the given encrypted password.
94+
"""
95+
config = load_yaml_config(TRAVIS_CONFIG_FILE)
96+
97+
config['deploy']['password'] = dict(secure=encrypted_password)
98+
99+
save_yaml_config(TRAVIS_CONFIG_FILE, config)
100+
101+
line = ('# This file was autogenerated and will overwrite'
102+
' each time you run travis_pypi_setup.py\n')
103+
prepend_line(TRAVIS_CONFIG_FILE, line)
104+
105+
106+
def main(args):
107+
public_key = fetch_public_key(args.repo)
108+
password = args.password or getpass('PyPI password: ')
109+
update_travis_deploy_password(encrypt(public_key, password.encode()))
110+
print("Wrote encrypted password to .travis.yml -- you're ready to deploy")
111+
112+
113+
if '__main__' == __name__:
114+
import argparse
115+
parser = argparse.ArgumentParser(description=__doc__)
116+
parser.add_argument('--repo', default=GITHUB_REPO,
117+
help='GitHub repo (default: %s)' % GITHUB_REPO)
118+
parser.add_argument('--password',
119+
help='PyPI password (will prompt if not provided)')
120+
121+
args = parser.parse_args()
122+
main(args)

0 commit comments

Comments
 (0)
Please sign in to comment.