FAQ | This is a LIVE service | Changelog

Commit d4b992af authored by Dr Abraham Martin's avatar Dr Abraham Martin
Browse files

Merge branch 'issue-1-upload-pypi' into 'master'

add PyPI packaging

Closes #1

See merge request !2
parents 20f94be6 f2eda685
Pipeline #37980 waiting for manual action with stages
in 8 minutes and 37 seconds
......@@ -13,6 +13,11 @@ include:
- project: 'uis/devops/continuous-delivery/ci-templates'
file: '/auto-devops/tox-tests.yml'
# Support uploading to PyPI
- project: 'uis/devops/continuous-delivery/ci-templates'
ref: v1.0.1
file: '/pypi-release.yml'
variables:
DOCUMENTATION_DISABLED: "1"
DAST_DISABLED: "1"
......@@ -46,7 +46,15 @@ geddit('sm://my-project/some-secret#3') # fetches version 3
## Installation
The library can be installed directly from the git repository:
The [latest release of this library on PyPI](https://pypi.org/project/geddit/)
can be installed using `pip`:
```bash
$ pip3 install geddit
```
The library can also be installed directly from the git repository if you want
the most up-to-date version.
```bash
$ pip3 install git+https://gitlab.developers.cam.ac.uk/uis/devops/lib/geddit.git
```
......@@ -57,6 +65,12 @@ $ cd /path/to/this/repo
$ pip3 install -e .
```
## Publishing a new release
See the [guidebook section on publishing to
PyPI](https://guidebook.devops.uis.cam.ac.uk/en/latest/workflow/pypi/) for more
information.
## License
This software is licensed under an MIT-like software license. See the [LICENSE
......
......@@ -16,9 +16,24 @@ def load_requirements():
]
with open("README.md") as fobj:
long_description = fobj.read()
setup(
name='geddit',
version='0.1.0',
name="geddit",
version="0.1.0",
author="University of Cambridge Information Services",
author_email="devops+geddit@uis.cam.ac.uk",
description="Zero-configuration fetching of configuration resources",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://gitlab.developers.cam.ac.uk/uis/devops/lib/geddit/",
packages=find_packages(),
install_requires=load_requirements(),
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment