Skip to content

Commit

Permalink
Initial commit - Lets go
Browse files Browse the repository at this point in the history
  • Loading branch information
dethos committed Sep 1, 2017
0 parents commit 49ae0aa
Show file tree
Hide file tree
Showing 31 changed files with 838 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[bumpversion]
current_version = 0.0.1
commit = True
tag = True

[bumpversion:file:setup.py]

[bumpversion:file:README.rst]

[bumpversion:file:docs/conf.py]

[bumpversion:file:src/auto_tune/__init__.py]

51 changes: 51 additions & 0 deletions .cookiecutterrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# This file exists so you can easily regenerate your project.
#
# `cookiepatcher` is a convenient shim around `cookiecutter`
# for regenerating projects (it will generate a .cookiecutterrc
# automatically for any template). To use it:
#
# pip install cookiepatcher
# cookiepatcher gh:ionelmc/cookiecutter-pylibrary project-path
#
# See:
# https://pypi.python.org/pypi/cookiepatcher
#
# Alternatively, you can run:
#
# cookiecutter --overwrite-if-exists --config-file=project-path/.cookiecutterrc gh:ionelmc/cookiecutter-pylibrary

default_context:

appveyor: 'no'
c_extension_cython: 'no'
c_extension_optional: 'no'
c_extension_support: 'no'
codacy: 'yes'
codeclimate: 'no'
codecov: 'yes'
command_line_interface: 'click'
command_line_interface_bin_name: 'auto-tune'
coveralls: 'no'
distribution_name: 'auto-tune'
email: '[email protected]'
full_name: 'Whitesmith, Lda'
github_username: 'whitesmith'
landscape: 'no'
license: 'MIT license'
linter: 'flake8'
package_name: 'auto_tune'
project_name: 'auto-tune'
project_short_description: 'Estimate hyper-parameter search using evolutionary algorithms'
release_date: 'today'
repo_name: 'auto-tune'
requiresio: 'yes'
scrutinizer: 'no'
sphinx_doctest: 'no'
sphinx_theme: 'sphinx-rtd-theme'
test_matrix_configurator: 'no'
test_matrix_separate_coverage: 'no'
test_runner: 'pytest'
travis: 'no'
version: '0.0.1'
website: 'https://whitesmith.co'
year: 'now'
16 changes: 16 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[paths]
source =
src/auto_tune
*/site-packages/auto_tune

[run]
branch = true
source =
auto_tune
tests
parallel = true

[report]
show_missing = true
precision = 2
omit = *migrations*
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# see http://editorconfig.org
root = true

[*]
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 4
charset = utf-8

[*.{bat,cmd,ps1}]
end_of_line = crlf
64 changes: 64 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
*.py[cod]

# C extensions
*.so

# Packages
*.egg
*.egg-info
dist
build
eggs
.eggs
parts
bin
var
sdist
wheelhouse
develop-eggs
.installed.cfg
lib
lib64
venv*/
pyvenv*/

# Installer logs
pip-log.txt

# Unit test / coverage reports
.coverage
.tox
.coverage.*
nosetests.xml
coverage.xml
htmlcov

# Translations
*.mo

# Mr Developer
.mr.developer.cfg
.project
.pydevproject
.idea
*.iml
*.komodoproject

# Complexity
output/*.html
output/*/index.html

# Sphinx
docs/_build

.DS_Store
*~
.*.sw[po]
.build
.ve
.env
.cache
.pytest
.bootstrap
.appveyor.token
*.bak
5 changes: 5 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

Authors
=======

* Whitesmith, Lda - https://whitesmith.co
8 changes: 8 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

Changelog
=========

0.0.1 (2017-09-01)
------------------

* First release on PyPI.
90 changes: 90 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
============
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.

Bug reports
===========

When `reporting a bug <https://github.com/whitesmith/auto-tune/issues>`_ please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Documentation improvements
==========================

auto-tune could always use more documentation, whether as part of the
official auto-tune docs, in docstrings, or even on the web in blog posts,
articles, and such.

Feature requests and feedback
=============================

The best way to send feedback is to file an issue at https://github.com/whitesmith/auto-tune/issues.

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development
===========

To set up `auto-tune` for local development:

1. Fork `auto-tune <https://github.com/whitesmith/auto-tune>`_
(look for the "Fork" button).
2. Clone your fork locally::

git clone [email protected]:your_name_here/auto-tune.git

3. Create a branch for local development::

git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

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::

tox

5. Commit your changes and push your branch to GitHub::

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

6. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------

If you need some code review or feedback while you're developing the code just make the pull request.

For merging, you should:

1. Include passing tests (run ``tox``) [1]_.
2. Update documentation when there's new API, functionality etc.
3. Add a note to ``CHANGELOG.rst`` about the changes.
4. Add yourself to ``AUTHORS.rst``.

.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
`run the tests <https://travis-ci.org/whitesmith/auto-tune/pull_requests>`_ for each change you add in the pull request.
It will be slower though ...
Tips
----

To run a subset of tests::

tox -e envname -- py.test -k test_myfeature

To run all the test environments in *parallel* (you need to ``pip install detox``)::

detox
9 changes: 9 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MIT License

Copyright (c) 2017, Whitesmith, Lda

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.
21 changes: 21 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
graft docs
graft examples
graft src
graft ci
graft tests

include .bumpversion.cfg
include .coveragerc
include .cookiecutterrc
include .editorconfig
include .isort.cfg

include AUTHORS.rst
include CHANGELOG.rst
include CONTRIBUTING.rst
include LICENSE
include README.rst

include tox.ini .travis.yml appveyor.yml

global-exclude *.py[cod] __pycache__ *.so *.dylib
97 changes: 97 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
========
Overview
========

.. start-badges
.. list-table::
:stub-columns: 1

* - docs
- |docs|
* - tests
- | |requires|
| |codecov|
| |codacy|
* - package
- | |version| |wheel| |supported-versions| |supported-implementations|
| |commits-since|
.. |docs| image:: https://readthedocs.org/projects/auto-tune/badge/?style=flat
:target: https://readthedocs.org/projects/auto-tune
:alt: Documentation Status

.. |requires| image:: https://requires.io/github/whitesmith/auto-tune/requirements.svg?branch=master
:alt: Requirements Status
:target: https://requires.io/github/whitesmith/auto-tune/requirements/?branch=master

.. |codecov| image:: https://codecov.io/github/whitesmith/auto-tune/coverage.svg?branch=master
:alt: Coverage Status
:target: https://codecov.io/github/whitesmith/auto-tune

.. |codacy| image:: https://img.shields.io/codacy/REPLACE_WITH_PROJECT_ID.svg
:target: https://www.codacy.com/app/whitesmith/auto-tune
:alt: Codacy Code Quality Status

.. |version| image:: https://img.shields.io/pypi/v/auto-tune.svg
:alt: PyPI Package latest release
:target: https://pypi.python.org/pypi/auto-tune

.. |commits-since| image:: https://img.shields.io/github/commits-since/whitesmith/auto-tune/v0.0.1.svg
:alt: Commits since latest release
:target: https://github.com/whitesmith/auto-tune/compare/v0.0.1...master

.. |wheel| image:: https://img.shields.io/pypi/wheel/auto-tune.svg
:alt: PyPI Wheel
:target: https://pypi.python.org/pypi/auto-tune

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/auto-tune.svg
:alt: Supported versions
:target: https://pypi.python.org/pypi/auto-tune

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/auto-tune.svg
:alt: Supported implementations
:target: https://pypi.python.org/pypi/auto-tune


.. end-badges
Estimate hyper-parameter search using evolutionary algorithms

* Free software: MIT license

Installation
============

::

pip install auto-tune

Documentation
=============

https://auto-tune.readthedocs.io/

Development
===========

To run the all tests run::

tox

Note, to combine the coverage data from all the tox environments run:

.. list-table::
:widths: 10 90
:stub-columns: 1

- - Windows
- ::

set PYTEST_ADDOPTS=--cov-append
tox

- - Other
- ::

PYTEST_ADDOPTS=--cov-append tox
Loading

0 comments on commit 49ae0aa

Please sign in to comment.