diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..42a4ce9 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +github: [ulf1] +patreon: ulfhamster +ko_fi: ulfhamster diff --git a/.github/workflows/pythonapp.yml b/.github/workflows/pythonapp.yml deleted file mode 100644 index 3a899b1..0000000 --- a/.github/workflows/pythonapp.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Python application - -on: [push] - -jobs: - build: - - runs-on: ubuntu-18.04 - - steps: - - uses: actions/checkout@v1 - - name: Set up Python 3.7 - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install -r requirements.txt - - name: Lint with flake8 - run: | - flake8 --ignore=F401 - - name: Unit Test with unittest - run: | - python -W ignore -m unittest discover diff --git a/.github/workflows/syntax-and-unit-tests.yml b/.github/workflows/syntax-and-unit-tests.yml new file mode 100644 index 0000000..9f27307 --- /dev/null +++ b/.github/workflows/syntax-and-unit-tests.yml @@ -0,0 +1,33 @@ +name: Python application + +on: [push] + +jobs: + build: + + runs-on: ubuntu-18.04 + + strategy: + matrix: + python-version: ['3.6', '3.7', '3.8', '3.x'] + + name: Python ${{ matrix.python-version }} Tests + + steps: + - uses: actions/checkout@v1 + - name: Setup python + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + architecture: x64 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + pip install -r requirements-dev.txt + - name: Lint with flake8 + run: | + flake8 --ignore=F401 --exclude=$(grep -v '^#' .gitignore | xargs | sed -e 's/ /,/g') + - name: Unit Test with pytest + run: | + python -W ignore -m unittest discover diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index b280bc1..0000000 --- a/.travis.yml +++ /dev/null @@ -1,11 +0,0 @@ -sudo: false -language: python -python: - - "3.6" -install: - - pip install flake8>=3.5.0 - - pip install -r requirements.txt -script: - - flake8 --ignore=F401 - - python -W ignore -m unittest discover -cache: pip diff --git a/CHANGES.md b/CHANGES.md index dd380a6..a4c50b6 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,12 @@ +# 0.3.2 / 2020-04-23 + + * Test multiple python versions + * Installation problems: remove pandoc from setup.py + +# 0.3.1 / 2021-04-08 + + * MIT License changed to Apache 2.0 + # 0.3.0 / 2019-11-16 * Shopping Holiday class diff --git a/LICENSE b/LICENSE index eda778e..11eee0a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2018 Ulf Hamster - -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. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 Ulf Hamster + + 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. diff --git a/MANIFEST.in b/MANIFEST.in index 77e3555..783709f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,3 @@ include README.md +include README.rst recursive-include test *.py diff --git a/README.md b/README.md index 838a3a5..22a2412 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -[![Build Status](https://travis-ci.org/kmedian/datefeatures.svg?branch=master)](https://travis-ci.org/kmedian/datefeatures) -[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/kmedian/datefeatures/master?urlpath=lab) -[![Gitpod - Code Now](https://img.shields.io/badge/Gitpod-code%20now-blue.svg?longCache=true)](https://gitpod.io#https://github.com/kmedian/datefeatures) +[![PyPI version](https://badge.fury.io/py/datefeatures.svg)](https://badge.fury.io/py/datefeatures) +[![datefeatures](https://snyk.io/advisor/python/datefeatures/badge.svg)](https://snyk.io/advisor/python/datefeatures) +[![Total alerts](https://img.shields.io/lgtm/alerts/g/kmedian/datefeatures.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/kmedian/datefeatures/alerts/) +[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/kmedian/datefeatures.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/kmedian/datefeatures/context:python) +[![deepcode](https://www.deepcode.ai/api/gh/badge?key=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwbGF0Zm9ybTEiOiJnaCIsIm93bmVyMSI6ImttZWRpYW4iLCJyZXBvMSI6ImRhdGVmZWF0dXJlcyIsImluY2x1ZGVMaW50IjpmYWxzZSwiYXV0aG9ySWQiOjI5NDUyLCJpYXQiOjE2MTk1MzYxMzR9.N7NgWjiFb0RXjg2MK8jsmf_2KPL8cWtkUhz02uZ-k2w)](https://www.deepcode.ai/app/gh/kmedian/datefeatures/_/dashboard?utm_content=gh%2Fkmedian%2Fdatefeatures) + # datefeatures @@ -42,7 +45,14 @@ Python commands * Jupyter for the examples: `jupyter lab` * Check syntax: `flake8 --ignore=F401 --exclude=$(grep -v '^#' .gitignore | xargs | sed -e 's/ /,/g')` * Run Unit Tests: `python -W ignore -m unittest discover` -* Upload to PyPi with twine: `python setup.py sdist && twine upload -r pypi dist/*` + +Publish + +```sh +pandoc README.md --from markdown --to rst -s -o README.rst +python setup.py sdist +twine upload -r pypi dist/* +``` Clean up diff --git a/datefeatures/__init__.py b/datefeatures/__init__.py index 116d565..79c71b5 100644 --- a/datefeatures/__init__.py +++ b/datefeatures/__init__.py @@ -1,3 +1,5 @@ +__version__ = '0.3.2' + from .datecomponents import DateComponents from .timecircle import TimeCircle from .monthcircle import ( diff --git a/datefeatures/monthcircle.py b/datefeatures/monthcircle.py index c35efa1..8342bdb 100644 --- a/datefeatures/monthcircle.py +++ b/datefeatures/monthcircle.py @@ -1,6 +1,6 @@ from sklearn.base import BaseEstimator, TransformerMixin import pandas as pd -import numpy as np +# import numpy as np from .timecircle import to_cos, to_sin from calendar import monthrange # for 'frac_month' diff --git a/datefeatures/shoppingholiday.py b/datefeatures/shoppingholiday.py index 7547f22..7699d89 100644 --- a/datefeatures/shoppingholiday.py +++ b/datefeatures/shoppingholiday.py @@ -1,11 +1,11 @@ # For ShoppingHolidayCalendar class import holidays from datetime import date, datetime -from dateutil.relativedelta import relativedelta, TH, FR +from dateutil.relativedelta import relativedelta, TH # For ShoppingHolidays class from sklearn.base import BaseEstimator, TransformerMixin -from scipy.sparse import csr_matrix, lil_matrix +from scipy.sparse import lil_matrix import numpy as np diff --git a/requirements-demo.txt b/requirements-demo.txt new file mode 100644 index 0000000..fb88a4d --- /dev/null +++ b/requirements-demo.txt @@ -0,0 +1,4 @@ +# packages required to run example notebooks +jupyterlab>=3.0.5 +randdate>=0.1.0 +mlxtend>=0.14.0 diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..ee14a46 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,7 @@ +# syntax check, unit test, profiling +setuptools>=56.0.0 +flake8>=3.8.4 +# pytest>=6.2.1 +twine==3.3.0 +pypandoc>=1.5 +wheel>=0.31.0 diff --git a/requirements.txt b/requirements.txt index 407c101..484e10f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,11 +1,5 @@ -# syntax check, unit test, profiling -flake8>=3.7.8 -nose>=1.3.7 # package dependencies numpy>=1.14.5 scikit-learn>=0.20.0 pandas>=0.23.4 holidays>=0.9.9 -# for examples -randdate>=0.1.0 -mlxtend>=0.14.0 diff --git a/setup.py b/setup.py index bc8f9b2..9bc2f53 100644 --- a/setup.py +++ b/setup.py @@ -1,26 +1,36 @@ from setuptools import setup +import os def read(fname): - import os - return open(os.path.join(os.path.dirname(__file__), fname)).read() + with open(os.path.join(os.path.dirname(__file__), fname)) as fp: + s = fp.read() + return s + + +def get_version(path): + with open(path, "r") as fp: + lines = fp.read() + for line in lines.split("\n"): + if line.startswith('__version__'): + delim = '"' if '"' in line else "'" + return line.split(delim)[1] + raise RuntimeError("Unable to find version string.") setup(name='datefeatures', - version='0.3.0', + version=get_version("datefeatures/__init__.py"), description='Feature engineering sklearn transformer for dates', - long_description=read('README.md'), - long_description_content_type='text/markdown', + long_description=read('README.rst'), url='http://github.com/kmedian/datefeatures', author='Ulf Hamster', author_email='554c46@gmail.com', - license='MIT', + license='Apache License 2.0', packages=['datefeatures'], install_requires=[ - 'setuptools>=40.0.0', 'numpy>=1.14.5', 'scikit-learn>=0.20.0', 'pandas>=0.23.4', 'holidays>=0.9.9'], python_requires='>=3.6', - zip_safe=False) + zip_safe=True)