Skip to content

Commit

Permalink
Add initial project skeleton
Browse files Browse the repository at this point in the history
Created using ionelmc's [cookiecutter][0] [template][1] with these
parameters:

        _template:                 'gh:ionelmc/cookiecutter-pylibrary'
        appveyor:                  'yes'
        c_extension_function:      'longest'
        c_extension_module:        '_oemof.tabular'
        c_extension_optional:      'yes'
        c_extension_support:       'no'
        codacy:                    'yes'
        codeclimate:               'yes'
        codecov:                   'yes'
        command_line_interface:    'no'
        command_line_interface_bin_name: '""'
        coveralls:                 'yes'
        distribution_name:         'oemof.tabular'
        email:                     'gnn.code@gmail.com'
        full_name:                 'Stephan Günther'
        github_username:           'gnn'
        landscape:                 'yes'
        license:                   'BSD 3-Clause License'
        linter:                    'flake8'
        package_name:              'oemof.tabular'
        project_name:              'oemof tabular'
        project_short_description: 'Load oemof energy systems from tabular
                                    data sources.'
        release_date:              '2018-11-23'
        repo_name:                 'oemof-tabular'
        requiresio:                'yes'
        scrutinizer:               'yes'
        sphinx_docs:               'yes'
        sphinx_doctest:            'no'
        sphinx_theme:              'sphinx-rtd-theme'
        test_matrix_configurator:  'yes'
        test_matrix_separate_coverage: 'yes'
        test_runner:               'nose'
        travis:                    'yes'
        version:                   '0.0.1'
        website:                   'https://oemof.org'
        year:                      'now'

For completeness: the cookiecutter version used was 1.6.0.

[0]: https://pypi.org/project/cookiecutter/
[1]: https://github.com/ionelmc/cookiecutter-pylibrary/tree/57b7f2eee38390303db1ed21cc8bce4d64620309
  • Loading branch information
gnn committed Nov 20, 2018
0 parents commit 461ec0e
Show file tree
Hide file tree
Showing 37 changed files with 1,705 additions and 0 deletions.
20 changes: 20 additions & 0 deletions .bumpversion.cfg
@@ -0,0 +1,20 @@
[bumpversion]
current_version = 0.0.1
commit = True
tag = True

[bumpversion:file:setup.py]
search = version='{current_version}'
replace = version='{new_version}'

[bumpversion:file:README.rst]
search = v{current_version}.
replace = v{new_version}.

[bumpversion:file:docs/conf.py]
search = version = release = '{current_version}'
replace = version = release = '{new_version}'

[bumpversion:file:src/oemof.tabular/__init__.py]
search = __version__ = '{current_version}'
replace = __version__ = '{new_version}'
54 changes: 54 additions & 0 deletions .cookiecutterrc
@@ -0,0 +1,54 @@
# 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:

_template: 'gh:ionelmc/cookiecutter-pylibrary'
appveyor: 'yes'
c_extension_function: 'longest'
c_extension_module: '_oemof.tabular'
c_extension_optional: 'yes'
c_extension_support: 'no'
codacy: 'yes'
codeclimate: 'yes'
codecov: 'yes'
command_line_interface: 'no'
command_line_interface_bin_name: '""'
coveralls: 'yes'
distribution_name: 'oemof.tabular'
email: 'gnn.code@gmail.com'
full_name: 'Stephan Günther'
github_username: 'gnn'
landscape: 'yes'
license: 'BSD 3-Clause License'
linter: 'flake8'
package_name: 'oemof.tabular'
project_name: 'oemof tabular'
project_short_description: 'Load oemof energy systems from tabular data sources.'
release_date: '2018-11-23'
repo_name: 'oemof-tabular'
requiresio: 'yes'
scrutinizer: 'yes'
sphinx_docs: 'yes'
sphinx_doctest: 'no'
sphinx_theme: 'sphinx-rtd-theme'
test_matrix_configurator: 'yes'
test_matrix_separate_coverage: 'yes'
test_runner: 'nose'
travis: 'yes'
version: '0.0.1'
website: 'https://oemof.org'
year: 'now'
14 changes: 14 additions & 0 deletions .coveragerc
@@ -0,0 +1,14 @@
[paths]
source = src

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

[report]
show_missing = true
precision = 2
omit = *migrations*
13 changes: 13 additions & 0 deletions .editorconfig
@@ -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
68 changes: 68 additions & 0 deletions .gitignore
@@ -0,0 +1,68 @@
*.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.*
.pytest_cache/
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

# Mypy Cache
.mypy_cache/
98 changes: 98 additions & 0 deletions .travis.yml
@@ -0,0 +1,98 @@
language: python
sudo: false
cache: pip
env:
global:
- LD_PRELOAD=/lib/x86_64-linux-gnu/libSegFault.so
- SEGFAULT_SIGNALS=all
matrix:
- TOXENV=check
- TOXENV=docs
matrix:
include:
- python: '2.7'
env:
- TOXENV=py27-cover,report,coveralls,codecov
- python: '2.7'
env:
- TOXENV=py27-nocov
- python: '3.4'
env:
- TOXENV=py34-cover,report,coveralls,codecov
- python: '3.4'
env:
- TOXENV=py34-nocov
- python: '3.5'
env:
- TOXENV=py35-cover,report,coveralls,codecov
- python: '3.5'
env:
- TOXENV=py35-nocov
- python: '3.6'
env:
- TOXENV=py36-cover,report,coveralls,codecov
- python: '3.6'
env:
- TOXENV=py36-nocov
- python: '3.7'
dist: xenial
sudo: required
env:
- TOXENV=py37-cover,report,coveralls,codecov
- python: '3.7'
dist: xenial
sudo: required
env:
- TOXENV=py37-nocov
- python: 'pypy'
env:
- TOXENV=pypy-cover,report,coveralls,codecov
- python: 'pypy'
env:
- TOXENV=pypy-nocov
- python: 'pypy3'
env:
- TOXENV=pypy3-cover,report,coveralls,codecov
- python: 'pypy3'
env:
- TOXENV=pypy3-nocov
before_install:
- python --version
- uname -a
- lsb_release -a
install:
- pip install tox
- virtualenv --version
- easy_install --version
- pip --version
- tox --version
- |
set -ex
if [[ $TRAVIS_PYTHON_VERSION == 'pypy' ]]; then
(cd $HOME
wget https://bitbucket.org/pypy/pypy/downloads/pypy2-v6.0.0-linux64.tar.bz2
tar xf pypy2-*.tar.bz2
pypy2-*/bin/pypy -m ensurepip
pypy2-*/bin/pypy -m pip install -U virtualenv)
export PATH=$(echo $HOME/pypy2-*/bin):$PATH
export TOXPYTHON=$(echo $HOME/pypy2-*/bin/pypy)
fi
if [[ $TRAVIS_PYTHON_VERSION == 'pypy3' ]]; then
(cd $HOME
wget https://bitbucket.org/pypy/pypy/downloads/pypy3-v6.0.0-linux64.tar.bz2
tar xf pypy3-*.tar.bz2
pypy3-*/bin/pypy3 -m ensurepip
pypy3-*/bin/pypy3 -m pip install -U virtualenv)
export PATH=$(echo $HOME/pypy3-*/bin):$PATH
export TOXPYTHON=$(echo $HOME/pypy3-*/bin/pypy3)
fi
set +x
script:
- tox -v
after_failure:
- more .tox/log/* | cat
- more .tox/*/log/* | cat
notifications:
email:
on_success: never
on_failure: always
5 changes: 5 additions & 0 deletions AUTHORS.rst
@@ -0,0 +1,5 @@

Authors
=======

* Stephan Günther - https://oemof.org
8 changes: 8 additions & 0 deletions CHANGELOG.rst
@@ -0,0 +1,8 @@

Changelog
=========

0.0.1 (2018-11-23)
------------------

* First release on PyPI.
90 changes: 90 additions & 0 deletions CONTRIBUTING.rst
@@ -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/gnn/oemof-tabular/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
==========================

oemof tabular could always use more documentation, whether as part of the
official oemof tabular 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/gnn/oemof-tabular/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 `oemof-tabular` for local development:

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

git clone git@github.com:your_name_here/oemof-tabular.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/gnn/oemof-tabular/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 -- pytest -k test_myfeature

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

detox

0 comments on commit 461ec0e

Please sign in to comment.