Skip to content

Commit 5135db1

Browse files
committed
update READMe, tweak package name, bump version in version.py
1 parent 15a0324 commit 5135db1

File tree

3 files changed

+48
-20
lines changed

3 files changed

+48
-20
lines changed

README.md

Lines changed: 46 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,59 @@ of the OSI-approved MIT license. Copyright (c) 2016-2017 Adobe Inc.
1212

1313
# Installation
1414

15-
You can get this package from PyPI: `pip install umapi-client`.
16-
Or you can download the posted package from GitHub and use pip
17-
to install from the download.
15+
`umapi-client.py` is published to the Python Packaging Index.
16+
17+
https://pypi.org/project/umapi-client/
18+
19+
It can be installed with pip:
20+
21+
```
22+
$ pip install umapi-client
23+
```
24+
25+
Or a dependency manager such as Poetry:
26+
27+
```
28+
$ poetry add umapi-client
29+
```
1830

1931
# Building
2032

21-
1. Clone this repository or download one of the posted releases.
22-
2. From the command line, change to the `umapi-client.py` directory.
23-
3. To install, run the command `python setup.py install`.
24-
[**NOTE**: To avoid needing admin/root privileges for the installation
25-
of needed dependencies,
26-
it is recommended that you use `virtualenv` (or equivalent)
27-
to make a virtual python environment. See the
28-
[virtualenvwrapper documentation](http://virtualenvwrapper.readthedocs.io/en/latest/index.html)
29-
for more information.
33+
[Poetry](https://python-poetry.org/) is required to build the package. Follow the instructions documented on
34+
Poetry's website to install it on your system.
35+
36+
1. Clone this repository
37+
```
38+
$ git clone https://github.com/adobe-apiplatform/umapi-client.py
39+
$ cd umapi-client.py
40+
```
41+
42+
2. Install dependencies to virtual environment.
43+
```
44+
$ poetry install
45+
```
46+
47+
3. The `build` command will create a source package (`.tar.gz`) and a wheel file (`.whl`) in the `dist` directory.
48+
```
49+
$ poetry build
50+
$ ls dist
51+
umapi-client-2.17.1.tar.gz umapi_client-2.17.1-py3-none-any.whl
52+
```
53+
3054
4. Some of the packages required by this module use encryption, and so may
31-
require you to do local builds of modules that use SSL. Typically, this
32-
will require you to have a python installed that supports compiling
33-
extensions.
34-
5. To run tests, use the command `python setup.py test`.
55+
require you to do local builds of modules that use SSL. Typically, this
56+
will require you to have a python installed that supports compiling
57+
extensions.
58+
59+
5. Run tests with `pytest`.
60+
```
61+
$ poetry run pytest
62+
```
3563

3664
# Usage
3765

3866
Usage documentation, as well as information about how to get client
39-
credentials for use of the UMAPI, can be found on the
40-
[umapi-client wiki](https://adobe-apiplatform.github.io/umapi-client.py/),
67+
credentials for use of the UMAPI, can be found in the
68+
[user guide](https://adobe-apiplatform.github.io/umapi-client.py/),
4169
whose sources are in the `docs` directory of this repository.
4270

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[tool.poetry]
2-
name = "umapi-client.py"
2+
name = "umapi-client"
33
version = "2.17.1"
44
description = "Client for the User Management API (UMAPI) from Adobe - see https://adobe.ly/2h1pHgV"
55
readme = "README.md"

umapi_client/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1919
# SOFTWARE.
2020

21-
__version__ = "2.17"
21+
__version__ = "2.17.1"

0 commit comments

Comments
 (0)