Merge pull request #90 from adorton-adobe/poetry

Switch from setup.py to Poetry

Author: bhunut-adobe

.github/workflows/build.yml

@@ -23,12 +23,11 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Set up Poetry
+      uses: abatilo/[email protected]
+      with:
+        poetry-version: 1.1.5
     - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip setuptools wheel
-        pip install -e .
-        pip install -e .[test]
-        pip install -e .[setup]
-    - name: Test with pytest
-      run: |
-        pytest
+      run: poetry install
+    - name: Run tests
+      run: poetry run pytest

.github/workflows/publish.yml

@@ -14,12 +14,14 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
+    - name: Set up Poetry
+      uses: abatilo/[email protected]
+      with:
+        poetry-version: 1.1.5
     - name: Build
-      run: python setup.py sdist bdist_wheel
+      run: |
+        poetry install
+        poetry build
     - name: Create release
       uses: actions/create-release@v1
       env:
@@ -40,6 +42,5 @@ jobs:
         release-tag: ${{ steps.get_version.outputs.version }}
     - name: Publish to PyPI
       env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: twine upload dist/*
+        POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
+      run: poetry publish

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016-2017 Adobe Inc.  All rights reserved.
+Copyright (c) 2016-2021 Adobe Inc.  All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -12,32 +12,60 @@ of the OSI-approved MIT license.  Copyright (c) 2016-2021 Adobe Inc.
 
 # Installation
 
-You can get this package from PyPI: `pip install umapi-client`.
-Or you can download the posted package from GitHub and use pip
-to install from the download.
+`umapi-client.py` is published to the Python Packaging Index.
+
+https://pypi.org/project/umapi-client/
+
+It can be installed with pip:
+
+```
+$ pip install umapi-client
+```
+
+Or a dependency manager such as Poetry:
+
+```
+$ poetry add umapi-client
+```
 
 # Building
 
-1. Clone this repository or download one of the posted releases.
-2. From the command line, change to the `umapi-client.py` directory.
-3. To install, run the command `python setup.py install`.
-[**NOTE**: To avoid needing admin/root privileges for the installation
-of needed dependencies,
-it is recommended that you use `virtualenv` (or equivalent)
-to make a virtual python environment.  See the
-[virtualenvwrapper documentation](http://virtualenvwrapper.readthedocs.io/en/latest/index.html)
-for more information.
+[Poetry](https://python-poetry.org/) is required to build the package. Follow the instructions documented on
+Poetry's website to install it on your system.
+
+1. Clone this repository
+   ```
+   $ git clone https://github.com/adobe-apiplatform/umapi-client.py
+   $ cd umapi-client.py
+   ```
+
+2. Install dependencies to virtual environment.
+   ```
+   $ poetry install
+   ```
+
+3. The `build` command will create a source package (`.tar.gz`) and a wheel file (`.whl`) in the `dist` directory.
+   ```
+   $ poetry build
+   $ ls dist
+   umapi-client-2.17.1.tar.gz  umapi_client-2.17.1-py3-none-any.whl
+   ```
+
 4. Some of the packages required by this module use encryption, and so may
-require you to do local builds of modules that use SSL.  Typically, this
-will require you to have a python installed that supports compiling
-extensions.
-5. To run tests, use the command `python setup.py test`.
+   require you to do local builds of modules that use SSL.  Typically, this
+   will require you to have a python installed that supports compiling
+   extensions.
+
+5. Run tests with `pytest`.
+   ```
+   $ poetry run pytest
+   ```
 
 # Usage
 
 Usage documentation, as well as information about how to get client
-credentials for use of the UMAPI, can be found on the
-[umapi-client wiki](https://adobe-apiplatform.github.io/umapi-client.py/),
+credentials for use of the UMAPI, can be found in the
+[user guide](https://adobe-apiplatform.github.io/umapi-client.py/),
 whose sources are in the `docs` directory of this repository.
 
 # License

docs/index.md

@@ -8,7 +8,7 @@ which provides Adobe Enterprise customers the ability to manage their users.  Th
 client makes it easy to access the UMAPI from a local Python application.
 
 This client is open source, maintained by Adobe, and distributed under the terms
-of the OSI-approved MIT license.  Copyright (c) 2016-2017 Adobe Inc.
+of the OSI-approved MIT license.  Copyright (c) 2016-2021 Adobe Inc.
 
 # Installation