Merge branch 'packaging' into 'master'

add packaging following best practices

See merge request pleroma/relay!30
This commit is contained in:
Izalia Mae 2021-10-16 00:42:24 +00:00
commit 69947bc60c
5 changed files with 46 additions and 14 deletions

View file

@ -15,7 +15,7 @@ in this package as the `LICENSE` file.
You need at least Python 3.6 (latest version of 3.x recommended) to make use of this software.
It simply will not run on older Python versions.
Install the dependencies as you normally would (`pip3 install -r requirements.txt`).
Download the project and install with pip (`pip3 install .`).
Copy `relay.yaml.example` to `relay.yaml` and edit it as appropriate:

3
pyproject.toml Normal file
View file

@ -0,0 +1,3 @@
[build-system]
requires = ["setuptools","wheel"]
build-backend = 'setuptools.build_meta'

View file

@ -1,13 +0,0 @@
aiohttp==3.3.2
async-timeout==3.0.0
attrs==18.1.0
chardet==3.0.4
idna==2.7
idna-ssl==1.1.0
multidict==4.3.1
pycryptodome==3.9.4
PyYAML>=5.1
simplejson==3.16.0
yarl==1.2.6
cachetools
async_lru

38
setup.cfg Normal file
View file

@ -0,0 +1,38 @@
[metadata]
name = relay
description = Generic LitePub relay (works with all LitePub consumers and Mastodon)
long_description = file: README.md
long_description_content_type = text/markdown; charset=UTF-8
url = https://git.pleroma.social/pleroma/relay
license = AGPLv3
license_file = LICENSE
classifiers =
Environment :: Console
License :: OSI Approved :: AGPLv3 License
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
project_urls =
Source = https://git.pleroma.social/pleroma/relay
Tracker = https://git.pleroma.social/pleroma/relay/-/issues
[options]
zip_safe = False
packages = find:
install_requires =
aiohttp>=3.5.4
async-timeout>=3.0.0
attrs>=18.1.0
chardet>=3.0.4
idna>=2.7
idna-ssl>=1.1.0; python_version < "3.7"
multidict>=4.3.1
pycryptodome>=3.9.4
PyYAML>=5.1
simplejson>=3.16.0
yarl>=1.2.6
cachetools
async_lru
python_requires = >=3.6

4
setup.py Normal file
View file

@ -0,0 +1,4 @@
import setuptools
if __name__ == "__main__":
setuptools.setup()