Skip to content

Commit 3c3c700

Browse files
anrputinaanrputina
committed
Adding template for package release and documentation
1 parent 4192c3f commit 3c3c700

32 files changed

+1114
-156
lines changed

Diff for: ‎.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

Diff for: ‎.github/ISSUE_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* OutlierDenStream 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+
```

Diff for: ‎.gitignore

100755100644
+102-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,102 @@
1-
.DS_Store
2-
*.pyc
3-
Examples/exampleLongSimulation.py
4-
Examples/NewExampleOldDatasets.py
5-
Examples/readGroundTruth.py
6-
Examples/result.txt
7-
DemoGui/
8-
Examples/LightReorganization.py
9-
Examples/
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
28+
# PyInstaller
29+
# Usually these files are written by a python script from a template
30+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
31+
*.manifest
32+
*.spec
33+
34+
# Installer logs
35+
pip-log.txt
36+
pip-delete-this-directory.txt
37+
38+
# Unit test / coverage reports
39+
htmlcov/
40+
.tox/
41+
.coverage
42+
.coverage.*
43+
.cache
44+
nosetests.xml
45+
coverage.xml
46+
*.cover
47+
.hypothesis/
48+
.pytest_cache/
49+
50+
# Translations
51+
*.mo
52+
*.pot
53+
54+
# Django stuff:
55+
*.log
56+
local_settings.py
57+
58+
# Flask stuff:
59+
instance/
60+
.webassets-cache
61+
62+
# Scrapy stuff:
63+
.scrapy
64+
65+
# Sphinx documentation
66+
docs/_build/
67+
68+
# PyBuilder
69+
target/
70+
71+
# Jupyter Notebook
72+
.ipynb_checkpoints
73+
74+
# pyenv
75+
.python-version
76+
77+
# celery beat schedule file
78+
celerybeat-schedule
79+
80+
# SageMath parsed files
81+
*.sage.py
82+
83+
# dotenv
84+
.env
85+
86+
# virtualenv
87+
.venv
88+
venv/
89+
ENV/
90+
91+
# Spyder project settings
92+
.spyderproject
93+
.spyproject
94+
95+
# Rope project settings
96+
.ropeproject
97+
98+
# mkdocs documentation
99+
/site
100+
101+
# mypy
102+
.mypy_cache/

Diff for: ‎.travis.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
language: python
2+
python:
3+
- 3.6
4+
- 3.5
5+
- 3.4
6+
install: pip install -U tox-travis
7+
script: tox
8+
deploy:
9+
provider: pypi
10+
distributions: sdist bdist_wheel
11+
user: anrputina
12+
password:
13+
secure: fXJSeu5R3hlGRXwg8SODrVkahsgMMZ5kjzacJETU9MBKg5sOuS8qE/Y4QHdm4VwzBjRvXFX1+lx+ppf7HIJDH5AizyPz/w26kMvSO4OlnsJmndniQS/CTw1ZxtSRFoZMwkW1VGej4a40t4hj3kIt6tQirn/mjvMZN2/K9lqVLiqx2m4nJXTmpKrffevm8ZkIAh4fQFVzNsjm8jJDEL2y+C+Y7psILQ8jjjzYyS2qsY4e5WRM1SbASwH+pzWIjMWqIY0bl7G4w53cAzGHiRfwCxLiX90VA3qMFWPfT4j1gsn/lR1Ncrdz82V9JQtjA6c9Rwz8TJ4z2kOCXsb3WpIU5ZovlZnNDYxihInXVXaS01rKfO6QyZz7gbV2ic2Tzsz6punev9FpaBe49nMLlyyy/HEeDDlbLFWGajhC9ezvL/a+AXx3dk+jPXpcRVrLInLxqQludcdiVhl4AdOjHvHRrL0aIm55dqLi2SBNPqgelxouqWXj2PupqZn5JADODOVq3G+wfdA1pwXlMf6muzt9Vl6TtA/vN63kmIkogK7llA02zQqdrjnr01Q+4aPbnJVJ3KyH3gPzb33kpXyvSJQEmb9MgcosI6bbouBJkZ+QttpYpcDKInKUdxMraKSvEv0fdUTl7R81zhi2NVHO6BIwRNfWqGaRIrG4e7V9oeiDVok=
14+
on:
15+
tags: true
16+
repo: anrputina/outlierdenstream
17+
python: 3.6

Diff for: ‎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+
* Andrian Putina <[email protected]>
9+
10+
Contributors
11+
------------
12+
13+
None yet. Why not be the first?

Diff for: ‎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/anrputina/outlierdenstream/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+
OutlierDenStream could always use more documentation, whether as part of the
42+
official OutlierDenStream 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/anrputina/outlierdenstream/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 `outlierdenstream` for local development.
61+
62+
1. Fork the `outlierdenstream` repo on GitHub.
63+
2. Clone your fork locally::
64+
65+
$ git clone [email protected]:your_name_here/outlierdenstream.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 outlierdenstream
70+
$ cd outlierdenstream/
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
80+
tests, including testing other Python versions with tox::
81+
82+
$ flake8 outlierdenstream tests
83+
$ python setup.py test or py.test
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 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check
106+
https://travis-ci.org/anrputina/outlierdenstream/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_outlierdenstream
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.

Diff for: ‎HISTORY.rst

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

Diff for: ‎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

0 commit comments

Comments
 (0)