From 8e834d6fbceb7d8f3680d2ab6df3b3092c0ecd82 Mon Sep 17 00:00:00 2001 From: Jeff MacLoue Date: Thu, 6 Jul 2023 12:56:22 +0300 Subject: [PATCH 1/2] Modern package harness --- .gitignore | 5 +++++ pyproject.toml | 6 ++++++ setup.cfg | 6 ++++++ setup.py | 4 +--- 4 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 .gitignore create mode 100644 pyproject.toml create mode 100644 setup.cfg diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5df3acb --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.sw? +.*.sw? +__pycache__/ +/dist +/*.egg-info/ diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..9130854 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[build-system] +requires = [ + "setuptools", + "requests", + ] +build-backend = "setuptools.build_meta" diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..657c93d --- /dev/null +++ b/setup.cfg @@ -0,0 +1,6 @@ +[metadata] +version = attr: bsg_restapi.__version__ + +[options] +install_requires = + requests diff --git a/setup.py b/setup.py index 140b776..ef107e4 100644 --- a/setup.py +++ b/setup.py @@ -1,9 +1,7 @@ -from distutils.core import setup -from bsg_restapi import __version__ +from setuptools import setup setup( name='bsg-restapi', - version=__version__, packages=['bsg_restapi'], url='https://github.com/bsgworld/bsg-python', license='BSD 2-Clause License', From ab7b16d6f68dea5e6b4daf1b1a942e3395606e21 Mon Sep 17 00:00:00 2001 From: Jeff MacLoue Date: Thu, 6 Jul 2023 13:35:13 +0300 Subject: [PATCH 2/2] Updated docs --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 76e9a1f..4257bdd 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,15 @@ Installation [Download](https://github.com/bsgworld/bsg-python/archive/master.zip) repository, decompress, install with `setup.py install` +Alternatively, use pip: + + pip install git+https://github.com/bsgworld/bsg-python.git + +or [Poetry](https://python-poetry.org/) to add a requirement: + + poetry add git+https://github.com/bsgworld/bsg-python.git + + Usage ----- See [BSG REST API Documentation](https://bsg.world/developers/rest-api/) for complete list of API clients, error codes, result codes etc.