Skip to content

Commit 2e5eca9

Browse files
dave-shawleydave-shawley
committed
SYN
0 parents  commit 2e5eca9

File tree

17 files changed

+268
-0
lines changed

17 files changed

+268
-0
lines changed

‎.gitignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
build/
2+
dist/
3+
env/
4+
__pycache__/
5+
Gemfile
6+
Gemfile.lock
7+
8+
.coverage
9+
*.pyc
10+
*.egg
11+
*.egg-info

‎.travis.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
language: python
2+
python:
3+
- '2.7'
4+
- '3.3'
5+
- '3.4'
6+
- pypy
7+
install:
8+
- pip install -qr dev-requirements.txt
9+
script:
10+
- nosetests
11+
deploy:
12+
provider: pypi
13+
user: daveshawley
14+
password:
15+
secure: GlAK7LyPin+goUjr1Vb6MJmI3duzihL3lyutfyZpmNz1BONbe3LZZB05FnoQLDPQGBVp0EpBnsgdsngtmumxBVbn5TJ8/oUNRUYfLOBrUyEFKurd8IDgfh1lJ+LtQvbZgie5hLG7DkHPr4gf0Gz4AIewrx9rypDc4Q8aerR2Suw=
16+
distributions: sdist bdist_wheel
17+
on:
18+
tags: true
19+
all_branches: true
20+
python: 3.4

‎HACKING‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Setting up your environment
2+
---------------------------
3+
4+
The easiest way to start working with this code is to set up a virtual
5+
environment and run ``env/bin/pip install -qr dev-requirements.txt``.
6+
That will install the necessary testing tools. Then you can run everything
7+
else using ``env/bin/python setup.py``:
8+
9+
- *setup.py nosetest* will run the tests using nose to test against the
10+
and generate a coverage report to stdout.
11+
12+
- *setup.py build_sphinx* will generate HTML documentation into
13+
*build/doc/html*. This is the doc set that is uploaded to Read The Docs.
14+
15+
- *setup.py flake8* will run the ``flake8`` utility and report on any
16+
static code analysis failures.
17+

‎HISTORY‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Changelog
2+
=========
3+
4+
* Next Release
5+
6+
- Create something amazing

‎LICENSE‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Copyright (c) 2014, Dave Shawley
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 the {organization} 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.

‎MANIFEST.in‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
include HACKING
2+
include HISTORY
3+
include LICENSE
4+
include .coveragerc
5+
include *requirements.txt
6+
include tests.py
7+
include tox.ini
8+
graft docs
9+
10+
global-exclude __pycache__
11+
global-exclude *.pyc
12+
global-exclude *.swp

‎README.rst‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
janitor Setuptools Extension
2+
============================
3+
4+
|Version| |Downloads| |Status| |License|
5+
6+
Extends the ``clean`` command to remove stuff generated by the
7+
development process.
8+
9+
Wait... Why? What??
10+
-------------------
11+
So ``setup.py clean`` is useful for developers of C extensions or
12+
anything else that takes advantage of the ``setup.py build`` command.
13+
Pure Python packages generate their own set of artifacts that clutter
14+
up the source tree. This package extends the clean command so that
15+
it removes the following artifacts as well:
16+
17+
* The distribution directory as generated by the ``sdist`` and ``bdist*``
18+
commands
19+
* Top-level *.egg-info* and *.egg* directories that *setup.py* creates
20+
* Local virtual environment directories
21+
* *__pycache__* directories
22+
23+
I come from a C/C++ background where the *Makefile* usually provide house
24+
keeping targets such as *clean*, *dist-clean*, and *maintainer-clean*.
25+
This extension is inspired by the same desire for a clean working
26+
environment.
27+
28+
Ok... Where?
29+
------------
30+
+---------------+-----------------------------------------------------+
31+
| Source | https://github.com/dave-shawley/setupext-janitor |
32+
+---------------+-----------------------------------------------------+
33+
| Status | https://travis-ci.org/dave-shawley/setupext-janitor |
34+
+---------------+-----------------------------------------------------+
35+
| Download | https://pypi.python.org/pypi/setupext-janitor |
36+
+---------------+-----------------------------------------------------+
37+
| Documentation | http://setupext-janitor.readthedocs.org/en/latest |
38+
+---------------+-----------------------------------------------------+
39+
| Issues | https://github.com/dave-shawley/setupext-janitor |
40+
+---------------+-----------------------------------------------------+
41+
42+
.. _setuptools: https://pythonhosted.org/setuptools/
43+
.. |Version| image:: https://badge.fury.io/py/setupext-janitor.svg
44+
:target: https://badge.fury.io/
45+
.. |Downloads| image:: https://pypip.in/d/setupext-janitor/badge.svg?
46+
:target: https://pypi.python.org/pypi/setupext-janitor
47+
.. |Status| image:: https://travis-ci.org/dave-shawley/setupext-janitor.svg
48+
:target: https://travis-ci.org/dave-shawley/setupext-janitor
49+
.. |License| image:: https://pypip.in/license/dave-shawley/badge.svg?
50+
:target: https://setupext-dave-shawley.readthedocs.org/
51+

‎dev-requirements.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
flake8>=2.2,<3
2+
coverage>=3.7,<4
3+
nose>1.3,<2
4+
pyflakes>=0.8,<1
5+
sphinx>=1.2,<2
6+
sphinx-rtd-theme>=0.1,<1

‎docs/conf.py‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#!/usr/bin/env python3
2+
# -*- coding: utf-8 -*-
3+
4+
import sphinx_rtd_theme
5+
6+
from setupext import janitor
7+
8+
9+
project = 'Setupext: janitor'
10+
copyright = '2014, Dave Shawley'
11+
version = janitor.__version__
12+
release = janitor.__version__
13+
14+
needs_sphinx = '1.0'
15+
extensions = [
16+
'sphinx.ext.autodoc',
17+
'sphinx.ext.intersphinx',
18+
'sphinx.ext.viewcode',
19+
]
20+
templates_path = []
21+
source_suffix = '.rst'
22+
source_encoding = 'utf-8-sig'
23+
master_doc = 'index'
24+
pygments_style = 'sphinx'
25+
html_theme = 'sphinx_rtd_theme'
26+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
27+
html_static_path = []
28+
exclude_patterns = []
29+
30+
intersphinx_mapping = {
31+
'python': ('http://docs.python.org/', None),
32+
}

‎docs/hacking.rst‎

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

0 commit comments

Comments
 (0)