Skip to content

Commit

Permalink
Changed packaging to use setuptools declarative config in setup.cfg. (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
clokep authored Oct 28, 2021
1 parent 4657df2 commit 9b2530e
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 65 deletions.
4 changes: 3 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ that offers more fully-featured integration.
Installation
------------
- Included as standard in the deb packages and docker images from matrix.org.
- If you installed into a virtualenv: `pip install matrix-synapse-ldap3`.
- If you installed into a virtualenv:
- Ensure pip is up-to-date: `pip install -U pip`.
- Install the LDAP password provider: `pip install matrix-synapse-ldap3`.
- For other installation mechanisms, see the documentation provided by the maintainer.

Usage
Expand Down
6 changes: 4 additions & 2 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ You will need push access to this repo as well as an account on PyPi with push
access to the
[matrix-synapse-ldap3](https://pypi.org/project/matrix-synapse-ldap3/) package.

You will need to install the `build` and `twine` packages.

1. Edit the `__version__` variable of `ldap_auth_provider.py` to the new release
version. This repository uses [Semantic Versioning](https://semver.org/).

Expand Down Expand Up @@ -35,8 +37,8 @@ version. This repository uses [Semantic Versioning](https://semver.org/).

1. Build and upload to PyPI:
```sh
python setup.py sdist
twine upload dist/matrix-synapse-ldap3-$ver.tar.gz
python -m build
twine upload dist/matrix-synapse-ldap3-$ver.tar.gz dist/matrix_synapse_ldap3-$ver-py3-none-any.whl
```

1. Create release on GH project page:
Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["setuptools>=39.2.0", "wheel"]
build-backend = "setuptools.build_meta"
18 changes: 18 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
[metadata]
name = matrix-synapse-ldap3
url = https://github.com/matrix-org/matrix-synapse-ldap3
version = attr: ldap_auth_provider.__version__
description = An LDAP3 auth provider for Synapse
long_description = file: README.rst
classifiers=
Development Status :: 4 - Beta
License :: OSI Approved :: Apache Software License
Programming Language :: Python :: 3 :: Only

[options]
install_requires =
Twisted>=15.1.0
ldap3>=2.8
service_identity
py_modules = ldap_auth_provider

[flake8]
max-line-length = 90
# W503 requires that binary operators be at the end, not start, of lines. Erik doesn't like it.
Expand Down
62 changes: 0 additions & 62 deletions setup.py

This file was deleted.

1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[tox]
envlist = packaging, pep8, py35, py36, py37, py38
isolated_build = True

[testenv]
deps =
Expand Down

0 comments on commit 9b2530e

Please sign in to comment.