@@ -12,31 +12,59 @@ of the OSI-approved MIT license. Copyright (c) 2016-2017 Adobe Inc.
12
12
13
13
# Installation
14
14
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
+ ```
18
30
19
31
# Building
20
32
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
+
30
54
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
+ ```
35
63
36
64
# Usage
37
65
38
66
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/ ) ,
41
69
whose sources are in the ` docs ` directory of this repository.
42
70
0 commit comments