Skip to content

Commit

Permalink
updated by cruft
Browse files Browse the repository at this point in the history
  • Loading branch information
cehbrecht committed Nov 30, 2023
1 parent bae9501 commit 07a444d
Show file tree
Hide file tree
Showing 18 changed files with 290 additions and 56 deletions.
71 changes: 37 additions & 34 deletions .cruft.json
Original file line number Diff line number Diff line change
@@ -1,36 +1,39 @@
{
"template": "https://github.com/bird-house/cookiecutter-birdhouse.git",
"commit": "f157ea8419fd4e32a9e4d52e613c90c807190e7e",
"skip": [
"emu/processes/wps_say_hello.py",
"tests/test_wps_hello.py",
"docs/source/notebooks/example.ipynb",
"environment.yml",
"requirements.txt",
"AUTHORS.rst",
"CHANGES.rst",
"docs/source/notebooks/index.rst",
"docs/source/processes.rst",
"emu/processes/__init__.py",
"tests/test_wps_caps.py"
],
"context": {
"cookiecutter": {
"full_name": "Carsten Ehbrecht",
"email": "[email protected]",
"github_username": "bird-house",
"project_name": "Emu",
"project_slug": "emu",
"project_repo_name": "emu",
"project_readthedocs_name": "emu",
"project_short_description": "WPS processes for testing and demos.",
"version": "0.12.0",
"open_source_license": "Apache Software License 2.0",
"http_port": "5000",
"_copy_without_render": [
"{{cookiecutter.project_slug}}/templates/*.cfg"
],
"_template": "https://github.com/bird-house/cookiecutter-birdhouse.git"
}
"template": "https://github.com/bird-house/cookiecutter-birdhouse.git",
"commit": "bc8a389e02a3e55e55dad7657671d91e2f238ed9",
"skip": [
"emu/processes/wps_say_hello.py",
"tests/test_wps_hello.py",
"docs/source/notebooks/example.ipynb",
"environment.yml",
"requirements.txt",
"AUTHORS.rst",
"CHANGES.rst",
"docs/source/notebooks/index.rst",
"docs/source/processes.rst",
"emu/processes/__init__.py",
"tests/test_wps_caps.py"
],
"context": {
"cookiecutter": {
"full_name": "Carsten Ehbrecht",
"email": "[email protected]",
"github_username": "bird-house",
"project_name": "Emu",
"project_slug": "emu",
"project_repo_name": "emu",
"project_readthedocs_name": "emu",
"project_short_description": "WPS processes for testing and demos.",
"version": "0.12.0",
"open_source_license": "Apache Software License 2.0",
"http_port": "5000",
"use_pytest": "y",
"create_author_file": "y",
"_copy_without_render": [
"{{cookiecutter.project_slug}}/templates/*.cfg"
],
"_template": "https://github.com/bird-house/cookiecutter-birdhouse.git"
}
}
},
"checkout": null
}
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,19 @@ testdata.json

# Merge conflict
*.orig

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/

# IDE settings
.vscode/
128 changes: 128 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
.. highlight:: shell

============
Contributing
============

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

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/bird-house/emu/issues.

If you are reporting a bug, 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.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

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

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/bird-house/emu/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 contributions
are welcome :)

Get Started!
------------

Ready to contribute? Here's how to set up `emu` for local development.

1. Fork the `emu` repo on GitHub.
2. Clone your fork locally::

$ git clone [email protected]:your_name_here/emu.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

$ mkvirtualenv emu
$ cd emu/
$ python setup.py develop

4. Create a branch for local development::

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

Now you can make your changes locally.

5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::

$ flake8 emu tests
$ python setup.py test or pytest
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

6. 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

7. Submit a pull request through the GitHub website.

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

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
https://travis-ci.com/bird-house/emu/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::

$ pytest tests.test_emu


Deploying
---------

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Then run::

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.
18 changes: 17 additions & 1 deletion LICENSE.txt → LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
Apache License
Apache Software License 2.0

Copyright (c) 2023, Carsten Ehbrecht

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

Expand Down
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
include Makefile
include *.txt
include *.rst
include tox.ini
recursive-include emu *
global-exclude __pycache__
global-exclude *.py[co]
5 changes: 4 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,13 @@ You can find information about contributing in our `Developer Guide`_.

Please use bumpversion_ to release a new version.


License
-------

Free software: Apache Software License 2.0
* Free software: Apache Software License 2.0
* Documentation: https://emu.readthedocs.io.


Credits
-------
Expand Down
3 changes: 0 additions & 3 deletions docs/source/.gitignore

This file was deleted.

1 change: 1 addition & 0 deletions docs/source/authors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../AUTHORS.rst
5 changes: 2 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# emu documentation build configuration file, created by
# sphinx-quickstart on Fri Jun 9 13:47:02 2017.
Expand Down Expand Up @@ -90,9 +89,9 @@
# the built documents.
#
# The short X.Y version.
version = "0.12.0"
version = emu.__version__
# The full version, including alpha/beta/rc tags.
release = "0.12.0"
release = emu.__version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
dev_guide
tutorial
processes
authors
changes

Indices and tables
Expand Down
6 changes: 3 additions & 3 deletions emu/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
# without importing the main package when its dependencies are not installed.
# See: https://packaging.python.org/guides/single-sourcing-package-version

__author__ = """Carsten Ehbrecht"""
__email__ = '[email protected]'
__version__ = '0.12.0'
__author__ = "Carsten Ehbrecht"
__email__ = "[email protected]"
__version__ = "0.12.0"
6 changes: 5 additions & 1 deletion emu/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,11 @@ def stop():
@click.option('--log-level', metavar='LEVEL', default='INFO', help='log level in PyWPS configuration.')
@click.option('--log-file', metavar='PATH', default='pywps.log', help='log file in PyWPS configuration.')
@click.option('--database', default='sqlite:///pywps-logs.sqlite', help='database in PyWPS configuration')
@click.option('--outputurl', default='', help='base URL for file downloads')
@click.option('--outputpath', default='', help='base directory where outputs are written')
def start(config, bind_host, daemon, hostname, port,
maxsingleinputsize, maxprocesses, parallelprocesses,
log_level, log_file, database):
log_level, log_file, database, outputurl, outputpath):
"""Start PyWPS service.
This service is by default available at http://localhost:5000/wps
"""
Expand All @@ -150,6 +152,8 @@ def start(config, bind_host, daemon, hostname, port,
wps_log_level=log_level,
wps_log_file=log_file,
wps_database=database,
wps_outputurl=outputurl,
wps_outputpath=outputpath
))
if config:
cfgfiles.append(config)
Expand Down
9 changes: 6 additions & 3 deletions requirements_dev.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
pytest>=6.0
pytest-runner
pytest-cov
flake8
tox
pytest-flake8
ipython
pytest-notebook
nbsphinx
nbval>=0.9.6
nbconvert
sphinx>=1.7
bumpversion
twine
sphinx>=1.8.5
bump2version
Click
cruft
# Changing dependencies above this comment will create merge conflicts when updating the cookiecutter template with cruft. Add extra requirements below this line.
locust
Expand Down
18 changes: 14 additions & 4 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ search = __version__ = '{current_version}'
replace = __version__ = '{new_version}'

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

[bumpversion:file:Dockerfile]
Expand Down Expand Up @@ -45,6 +45,16 @@ exclude =
dist,
src,

[doc8]
ignore-path = docs/build,docs/source/_templates,docs/source/_static
max-line-length = 120
[aliases]
# Define setup.py command aliases here
test = pytest

[tool:pytest]
addopts =
--strict-markers
--tb=native
tests/
python_files = test_*.py
markers =
online: mark test to need internet connection
slow: mark test to be slow
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""The setup script."""

Expand Down
2 changes: 0 additions & 2 deletions tests/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# -*- coding: utf-8 -*-

"""Unit test package for emu."""
Loading

0 comments on commit 07a444d

Please sign in to comment.