A small example package
Project description
mattermost-utils
Requirements
- pip package manager
- python version 3.8
Deployment on Linux
- Clone project on your local machine
git clone https://gitlab.tech.orange/dtrs-security/devops/mattermost-utils.git
Usage
Build
Make sure you have the latest versions of setuptools and wheel installed:
python3 -m pip install --user --upgrade setuptools wheel
Now run this command from the same directory where setup.py is located:
python setup.py sdist bdist_wheel
This command should output a lot of text and once completed should generate two files in the dist directory:
dist/
mattermost_post_utils-0.0.1-py3-none-any.whl
mattermost_post_utils-0.0.1.tar.gz
Uploading the distribution archives
The first thing you’ll need to do is register an account on PyPI
Now you’ll create a PyPI API token so you will be able to securely upload your project. Go to https://test.pypi.org/manage/account/#api-tokens and create a new API token; don’t limit its scope to a particular project, since you are creating a new project.
Don’t close the page until you have copied and saved the token — you won’t see that token again.
Now that you are registered, you can use twine to upload the distribution packages. You’ll need to install Twine:
python3 -m pip install --user --upgrade twine
Once installed, run Twine to upload all of the archives under dist:
python3 -m twine upload dist/*
You will be prompted for a username and password. For the username, use token. For the password, use the token value, including the pypi- prefix.
After the command completes, you should see output similar to this:
Uploading distributions to https://pypi.org/legacy/
Enter your username: __token__
Enter your password: <your_token>
Uploading example_pkg_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
100%|█████████████████████| 4.65k/4.65k [00:01<00:00, 2.88kB/s]
Uploading example_pkg_YOUR_USERNAME_HERE-0.0.1.tar.gz
100%|█████████████████████| 4.25k/4.25k [00:01<00:00, 3.05kB/s]
Once uploaded your package should be viewable on TestPyPI, for example, https://pypi.org/project/example-pkg-YOUR-USERNAME-HERE
Installing your newly uploaded package
You can use pip to install your package and verify that it works.
python3 -m pip install --no-deps example-pkg-YOUR-USERNAME-HERE
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mattermost_post_utils-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b40db7ba3832eba82cac88461aec2438bc4203b79174fc1bc00c15d6c2e9573e |
|
MD5 | ab9d8740b41b5a8fb81d1a6caae98818 |
|
BLAKE2b-256 | e89b4c3522e3efb442743a582b6b33260438b17543b17a2a5abb750ca6d58012 |
Hashes for mattermost_post_utils-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aea04b03687f76a5a514f121d32d650b9df47ec715879b8da35353728d2306ec |
|
MD5 | 7798fd2aadf53721b93570d96f9e3c9a |
|
BLAKE2b-256 | e132cdd76ae9bb051e156c9e423b8202c105ddc134a60635c5eea8ff3a3554b6 |