Skip to content

Commit 49ae0aa

Browse files
dethosdethos
committed
Initial commit - Lets go
0 parents  commit 49ae0aa

31 files changed

+838
-0
lines changed

‎.bumpversion.cfg

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[bumpversion]
2+
current_version = 0.0.1
3+
commit = True
4+
tag = True
5+
6+
[bumpversion:file:setup.py]
7+
8+
[bumpversion:file:README.rst]
9+
10+
[bumpversion:file:docs/conf.py]
11+
12+
[bumpversion:file:src/auto_tune/__init__.py]
13+

‎.cookiecutterrc

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# This file exists so you can easily regenerate your project.
2+
#
3+
# `cookiepatcher` is a convenient shim around `cookiecutter`
4+
# for regenerating projects (it will generate a .cookiecutterrc
5+
# automatically for any template). To use it:
6+
#
7+
# pip install cookiepatcher
8+
# cookiepatcher gh:ionelmc/cookiecutter-pylibrary project-path
9+
#
10+
# See:
11+
# https://pypi.python.org/pypi/cookiepatcher
12+
#
13+
# Alternatively, you can run:
14+
#
15+
# cookiecutter --overwrite-if-exists --config-file=project-path/.cookiecutterrc gh:ionelmc/cookiecutter-pylibrary
16+
17+
default_context:
18+
19+
appveyor: 'no'
20+
c_extension_cython: 'no'
21+
c_extension_optional: 'no'
22+
c_extension_support: 'no'
23+
codacy: 'yes'
24+
codeclimate: 'no'
25+
codecov: 'yes'
26+
command_line_interface: 'click'
27+
command_line_interface_bin_name: 'auto-tune'
28+
coveralls: 'no'
29+
distribution_name: 'auto-tune'
30+
email: '[email protected]'
31+
full_name: 'Whitesmith, Lda'
32+
github_username: 'whitesmith'
33+
landscape: 'no'
34+
license: 'MIT license'
35+
linter: 'flake8'
36+
package_name: 'auto_tune'
37+
project_name: 'auto-tune'
38+
project_short_description: 'Estimate hyper-parameter search using evolutionary algorithms'
39+
release_date: 'today'
40+
repo_name: 'auto-tune'
41+
requiresio: 'yes'
42+
scrutinizer: 'no'
43+
sphinx_doctest: 'no'
44+
sphinx_theme: 'sphinx-rtd-theme'
45+
test_matrix_configurator: 'no'
46+
test_matrix_separate_coverage: 'no'
47+
test_runner: 'pytest'
48+
travis: 'no'
49+
version: '0.0.1'
50+
website: 'https://whitesmith.co'
51+
year: 'now'

‎.coveragerc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[paths]
2+
source =
3+
src/auto_tune
4+
*/site-packages/auto_tune
5+
6+
[run]
7+
branch = true
8+
source =
9+
auto_tune
10+
tests
11+
parallel = true
12+
13+
[report]
14+
show_missing = true
15+
precision = 2
16+
omit = *migrations*

‎.editorconfig

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# see http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
end_of_line = lf
6+
trim_trailing_whitespace = true
7+
insert_final_newline = true
8+
indent_style = space
9+
indent_size = 4
10+
charset = utf-8
11+
12+
[*.{bat,cmd,ps1}]
13+
end_of_line = crlf

‎.gitignore

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
*.py[cod]
2+
3+
# C extensions
4+
*.so
5+
6+
# Packages
7+
*.egg
8+
*.egg-info
9+
dist
10+
build
11+
eggs
12+
.eggs
13+
parts
14+
bin
15+
var
16+
sdist
17+
wheelhouse
18+
develop-eggs
19+
.installed.cfg
20+
lib
21+
lib64
22+
venv*/
23+
pyvenv*/
24+
25+
# Installer logs
26+
pip-log.txt
27+
28+
# Unit test / coverage reports
29+
.coverage
30+
.tox
31+
.coverage.*
32+
nosetests.xml
33+
coverage.xml
34+
htmlcov
35+
36+
# Translations
37+
*.mo
38+
39+
# Mr Developer
40+
.mr.developer.cfg
41+
.project
42+
.pydevproject
43+
.idea
44+
*.iml
45+
*.komodoproject
46+
47+
# Complexity
48+
output/*.html
49+
output/*/index.html
50+
51+
# Sphinx
52+
docs/_build
53+
54+
.DS_Store
55+
*~
56+
.*.sw[po]
57+
.build
58+
.ve
59+
.env
60+
.cache
61+
.pytest
62+
.bootstrap
63+
.appveyor.token
64+
*.bak

‎AUTHORS.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
Authors
3+
=======
4+
5+
* Whitesmith, Lda - https://whitesmith.co

‎CHANGELOG.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
Changelog
3+
=========
4+
5+
0.0.1 (2017-09-01)
6+
------------------
7+
8+
* First release on PyPI.

‎CONTRIBUTING.rst

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
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+
Bug reports
9+
===========
10+
11+
When `reporting a bug <https://github.com/whitesmith/auto-tune/issues>`_ please include:
12+
13+
* Your operating system name and version.
14+
* Any details about your local setup that might be helpful in troubleshooting.
15+
* Detailed steps to reproduce the bug.
16+
17+
Documentation improvements
18+
==========================
19+
20+
auto-tune could always use more documentation, whether as part of the
21+
official auto-tune docs, in docstrings, or even on the web in blog posts,
22+
articles, and such.
23+
24+
Feature requests and feedback
25+
=============================
26+
27+
The best way to send feedback is to file an issue at https://github.com/whitesmith/auto-tune/issues.
28+
29+
If you are proposing a feature:
30+
31+
* Explain in detail how it would work.
32+
* Keep the scope as narrow as possible, to make it easier to implement.
33+
* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
34+
35+
Development
36+
===========
37+
38+
To set up `auto-tune` for local development:
39+
40+
1. Fork `auto-tune <https://github.com/whitesmith/auto-tune>`_
41+
(look for the "Fork" button).
42+
2. Clone your fork locally::
43+
44+
git clone [email protected]:your_name_here/auto-tune.git
45+
46+
3. Create a branch for local development::
47+
48+
git checkout -b name-of-your-bugfix-or-feature
49+
50+
Now you can make your changes locally.
51+
52+
4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.io/en/latest/install.html>`_ one command::
53+
54+
tox
55+
56+
5. Commit your changes and push your branch to GitHub::
57+
58+
git add .
59+
git commit -m "Your detailed description of your changes."
60+
git push origin name-of-your-bugfix-or-feature
61+
62+
6. Submit a pull request through the GitHub website.
63+
64+
Pull Request Guidelines
65+
-----------------------
66+
67+
If you need some code review or feedback while you're developing the code just make the pull request.
68+
69+
For merging, you should:
70+
71+
1. Include passing tests (run ``tox``) [1]_.
72+
2. Update documentation when there's new API, functionality etc.
73+
3. Add a note to ``CHANGELOG.rst`` about the changes.
74+
4. Add yourself to ``AUTHORS.rst``.
75+
76+
.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
77+
`run the tests <https://travis-ci.org/whitesmith/auto-tune/pull_requests>`_ for each change you add in the pull request.
78+
79+
It will be slower though ...
80+
81+
Tips
82+
----
83+
84+
To run a subset of tests::
85+
86+
tox -e envname -- py.test -k test_myfeature
87+
88+
To run all the test environments in *parallel* (you need to ``pip install detox``)::
89+
90+
detox

‎LICENSE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright (c) 2017, Whitesmith, Lda
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎MANIFEST.in

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
graft docs
2+
graft examples
3+
graft src
4+
graft ci
5+
graft tests
6+
7+
include .bumpversion.cfg
8+
include .coveragerc
9+
include .cookiecutterrc
10+
include .editorconfig
11+
include .isort.cfg
12+
13+
include AUTHORS.rst
14+
include CHANGELOG.rst
15+
include CONTRIBUTING.rst
16+
include LICENSE
17+
include README.rst
18+
19+
include tox.ini .travis.yml appveyor.yml
20+
21+
global-exclude *.py[cod] __pycache__ *.so *.dylib

‎README.rst

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
========
2+
Overview
3+
========
4+
5+
.. start-badges
6+
7+
.. list-table::
8+
:stub-columns: 1
9+
10+
* - docs
11+
- |docs|
12+
* - tests
13+
- | |requires|
14+
| |codecov|
15+
| |codacy|
16+
* - package
17+
- | |version| |wheel| |supported-versions| |supported-implementations|
18+
| |commits-since|
19+
20+
.. |docs| image:: https://readthedocs.org/projects/auto-tune/badge/?style=flat
21+
:target: https://readthedocs.org/projects/auto-tune
22+
:alt: Documentation Status
23+
24+
.. |requires| image:: https://requires.io/github/whitesmith/auto-tune/requirements.svg?branch=master
25+
:alt: Requirements Status
26+
:target: https://requires.io/github/whitesmith/auto-tune/requirements/?branch=master
27+
28+
.. |codecov| image:: https://codecov.io/github/whitesmith/auto-tune/coverage.svg?branch=master
29+
:alt: Coverage Status
30+
:target: https://codecov.io/github/whitesmith/auto-tune
31+
32+
.. |codacy| image:: https://img.shields.io/codacy/REPLACE_WITH_PROJECT_ID.svg
33+
:target: https://www.codacy.com/app/whitesmith/auto-tune
34+
:alt: Codacy Code Quality Status
35+
36+
.. |version| image:: https://img.shields.io/pypi/v/auto-tune.svg
37+
:alt: PyPI Package latest release
38+
:target: https://pypi.python.org/pypi/auto-tune
39+
40+
.. |commits-since| image:: https://img.shields.io/github/commits-since/whitesmith/auto-tune/v0.0.1.svg
41+
:alt: Commits since latest release
42+
:target: https://github.com/whitesmith/auto-tune/compare/v0.0.1...master
43+
44+
.. |wheel| image:: https://img.shields.io/pypi/wheel/auto-tune.svg
45+
:alt: PyPI Wheel
46+
:target: https://pypi.python.org/pypi/auto-tune
47+
48+
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/auto-tune.svg
49+
:alt: Supported versions
50+
:target: https://pypi.python.org/pypi/auto-tune
51+
52+
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/auto-tune.svg
53+
:alt: Supported implementations
54+
:target: https://pypi.python.org/pypi/auto-tune
55+
56+
57+
.. end-badges
58+
59+
Estimate hyper-parameter search using evolutionary algorithms
60+
61+
* Free software: MIT license
62+
63+
Installation
64+
============
65+
66+
::
67+
68+
pip install auto-tune
69+
70+
Documentation
71+
=============
72+
73+
https://auto-tune.readthedocs.io/
74+
75+
Development
76+
===========
77+
78+
To run the all tests run::
79+
80+
tox
81+
82+
Note, to combine the coverage data from all the tox environments run:
83+
84+
.. list-table::
85+
:widths: 10 90
86+
:stub-columns: 1
87+
88+
- - Windows
89+
- ::
90+
91+
set PYTEST_ADDOPTS=--cov-append
92+
tox
93+
94+
- - Other
95+
- ::
96+
97+
PYTEST_ADDOPTS=--cov-append tox

0 commit comments

Comments
 (0)