Skip to content

Commit

Permalink
update license and change CI to github actions
Browse files Browse the repository at this point in the history
  • Loading branch information
Chilipp committed Jun 28, 2021
1 parent e47edc3 commit e1a0943
Show file tree
Hide file tree
Showing 8 changed files with 331 additions and 362 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Tests

on:
push:
pull_request:

jobs:
build:

runs-on: ubuntu-latest

strategy:
matrix:
python-version: [3.6, 3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Display Python version
run: python -c "import sys; print(sys.version)"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pytest pytest-cov codecov -e .
- name: Test with pytest
run: |
pytest --cov=funcargparse --cov-report=xml tests
- name: Upload codecov
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
run: |
codecov
18 changes: 0 additions & 18 deletions .travis.yml

This file was deleted.

540 changes: 201 additions & 339 deletions LICENSE

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,21 @@ extract the necessary parts from the docstrings.
The package has been tested for python 2.7 and 3.5.

.. _docrep: http://docrep.readthedocs.io/en/latest/


Disclaimer
==========
Copyright 2016-2019, Philipp S. Sommer
Copyright 2020-2021, Helmholtz-Zentrum Hereon

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.
19 changes: 19 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,25 @@ The package has been tested for python 2.7 and 3.5.
.. _docrep: http://docrep.readthedocs.io/en/latest/


Disclaimer
==========

Copyright 2016-2019, Philipp S. Sommer
Copyright 2020-2021, Helmholtz-Zentrum Hereon

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.


Indices and tables
==================

Expand Down
34 changes: 33 additions & 1 deletion funcargparse/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
"""Generate an ArgumentParser from the docstring.
**Disclaimer**
Copyright 2016-2019, Philipp S. Sommer
Copyright 2020-2021, Helmholtz-Zentrum Hereon
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.
"""
from __future__ import print_function, division
import os
import six
Expand All @@ -23,7 +42,20 @@
import builtins


__version__ = '0.2.3'
__author__ = "Philipp S. Sommer"
__copyright__ = (
"2016 - 2019, Philipp S. Sommer\n"
"2020 - 2021, Helmholtz-Zentrum Hereon"
)
__credits__ = ["Philipp S. Sommer"]
__license__ = "Apache-2.0"

__maintainer__ = "Philipp S. Sommer"
__email__ = "philipp.sommer@hereon.de"

__status__ = "Production"

__version__ = '0.2.4'


docstrings = docrep.DocstringProcessor()
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def readme():


setup(name='funcargparse',
version='0.2.3',
version='0.2.4',
description=(
'Create an argparse.ArgumentParser from function docstrings'),
long_description=readme(),
Expand All @@ -37,8 +37,8 @@ def readme():
'Tracker': 'https://github.com/Chilipp/funcargparse/issues',
},
author='Philipp S. Sommer',
author_email='philipp.sommer@hzg.de',
license="GPLv2",
author_email='philipp.sommer@hereon.de',
license="Apache-2.0",
packages=find_packages(exclude=['docs', 'tests*', 'examples']),
include_package_data=True,
install_requires=[
Expand Down
20 changes: 19 additions & 1 deletion tests/test_funcargparse.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
"""Test module for the :mod:`gwgen.main` module"""
"""Test module for the :mod:`funcargparse` module.
**Disclaimer**
Copyright 2016-2019, Philipp S. Sommer
Copyright 2020-2021, Helmholtz-Zentrum Hereon
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.
"""
import unittest
import six
from funcargparse import FuncArgParser, docstrings
Expand Down

0 comments on commit e1a0943

Please sign in to comment.