setting up for first publication, copied setup structure and github action pipeline from entsoe-py

Author: fboerman

.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,46 @@
+name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+      - name: Upload distribution 📦 to release
+        uses: svenstaro/upload-release-action@2.2.1
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: dist/*.whl
+          file_glob: true
+          tag: ${{ github.ref }}
+      - name: Publish distribution 📦 to Test PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -0,0 +1,21 @@
+# jao-py
+Python client for the various endpoints offered by jao.eu, the Joint Allocation Office.
+"Europe's single leading trading platform( e-CAT) for cross-border transmission capacity"
+
+More information about JAO can be found on their website https://jao.eu/
+
+jao.eu has various ways of retrieving data. This package tries to offer useful functions to handle them.
+This package is not exhaustive, more methods are added when the authors needs them.
+If you want to see other methods added please either open a feature request issue to give others ideas or 
+supply a pull request yourself.
+
+
+## Installation
+`python3 -m pip install jao-py`
+
+## Usage
+The package comes with 4 clients:
+- [`JaoAPIClient`](#JaoAPIClient): api client for the normal http api
+- [`JaoUtilityToolASMXClient`](#JaoUtilityToolASMXClient): a very light wrapper around the ASMX Web Service API implemented as a passthrough to the suds-community pakcage
+- [`JaoUtilityToolCSVClient`](#JaoUtilityToolCSVClient): client to download csv data inm the same way as the utility tool excel file, returns pandas dataframes
+- [`JaoUtilityToolXmlClient`](#JaoUtilityToolXmlClient): downloads xml data of the utilitytool, this requires solving a captcha by the user, returns pandas dataframes

jao/jao.py

@@ -163,7 +163,7 @@ def help(self):
 
 
 class JaoUtilityToolCSVClient:
-    # this ingests from the same client the excell macros in the utility tool is talking too
+    # this ingests from the same client the excel macros in the utility tool is talking too
     # because of this the endpoints are open and thus no key or captcha is required
     def __init__(self):
         self.s = requests.Session()

manifest.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE.md
+include requirements.txt
+include jao/*

setup.cfg

@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md

setup.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+
+"""
+A setuptools based setup module for jao-py
+
+Adapted from
+https://packaging.python.org/en/latest/distributing.html
+https://github.com/pypa/sampleproject
+"""
+
+# Always prefer setuptools over distutils
+from setuptools import setup, find_packages
+# To use a consistent encoding
+from codecs import open
+from os import path
+
+here = path.abspath(path.dirname(__file__))
+
+# Get the long description from the README file
+with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+# Get the version from the source code
+with open(path.join(here, 'jao', 'jao.py'), encoding='utf-8') as f:
+    lines = f.readlines()
+    for l in lines:
+        if l.startswith('__version__'):
+            __version__ = l.split('"')[1] # take the part after the first "
+
+setup(
+    name='jao-py',
+    version=__version__,
+    description='A python API wrapper for JAO.eu',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/fboerman/jao-py',
+    author='Frank Boerman',
+    author_email='frank@fboerman.nl',
+    license='MIT',
+
+    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+
+        # Indicate who your project is intended for
+        'Intended Audience :: Developers',
+        'Topic :: Scientific/Engineering',
+
+        # Pick your license as you wish (should match "license" above)
+        'License :: OSI Approved :: MIT License',
+
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate whether you support Python 2, Python 3 or both.
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+    ],
+
+    keywords='JAO data api energy',
+
+    # You can just specify the packages manually here if your project is
+    # simple. Or you can use find_packages().
+    packages=find_packages(),
+
+
+    # List run-time dependencies here.  These will be installed by pip when
+    # your project is installed.
+    install_requires=['requests', 'pandas', 'suds-community', 'python-dateutil', 'beautifulsoup4', 'lxml', 'pillow'],
+
+    # If there are data files included in your packages that need to be
+    # installed, specify them here.  If using Python 2.6 or less, then these
+    # have to be included in MANIFEST.in as well.
+    # Note: for creating the source distribution, they had to be included in the
+    # MANIFEST.in as well.
+    package_data={
+        'jao-py': ['LICENSE.md', 'README.md'],
+    },
+)