Do a bit of housekeeping
- Switch from setup.py to pyproject.toml - Make README markdown based. - Bump version.
This commit is contained in:
parent
75833c7c4b
commit
6420575545
|
@ -1,28 +1,41 @@
|
||||||
THIS IS
|
# cpsms
|
||||||
|
|
||||||
|
## This is
|
||||||
|
|
||||||
A Python 3 wrapper around the SMS gateway from CPSMS <https://www.cpsms.dk/>.
|
A Python 3 wrapper around the SMS gateway from CPSMS <https://www.cpsms.dk/>.
|
||||||
|
|
||||||
THIS IS NOT
|
|
||||||
|
## This is not
|
||||||
|
|
||||||
Some sort of magic, free SMS gateway.
|
Some sort of magic, free SMS gateway.
|
||||||
|
|
||||||
INSTALLATION
|
|
||||||
cpsms is available from PyPI <https://pypi.python.org/pypi/cpsms>.
|
|
||||||
Easiest way to install is: `pip install cpsms`.
|
|
||||||
|
|
||||||
REQUIREMENTS
|
## Installation
|
||||||
|
|
||||||
|
`cpsms` is available [from PyPI](https://pypi.python.org/pypi/cpsms). Easiest
|
||||||
|
way to install is: `pip install cpsms`.
|
||||||
|
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
You need to have a (paid) account at CPSMS to be able to use their gateway.
|
You need to have a (paid) account at CPSMS to be able to use their gateway.
|
||||||
They sell a fair, no-nonsense product which I'd recommend if you want to be
|
They sell a fair, no-nonsense product which I'd recommend if you want to be
|
||||||
able to send SMS from your code (primarily to Danish phones).
|
able to send SMS from your code (primarily to Danish phones).
|
||||||
|
|
||||||
HOW TO USE
|
|
||||||
See a couple of example use cases in example.py that should have come
|
|
||||||
along with this file. Apart from what is shown in examples.py, this also
|
|
||||||
supports status callback URLs, delayed sending and flash messages.
|
|
||||||
|
|
||||||
FURTHER INFO
|
## How to use
|
||||||
For more info on parameters, take a look at the API documentation found at:
|
|
||||||
<https://www.cpsms.dk/login/index.php?page=dokumentation>.
|
|
||||||
|
|
||||||
I believe the gateway software running at the CPSMS server is some sort of
|
See a couple of example use cases in [example.py](./examples.py) that should
|
||||||
|
have come along with this file. Apart from what is shown in examples.py, this
|
||||||
|
also supports status callback URLs, delayed sending and flash messages.
|
||||||
|
|
||||||
|
|
||||||
|
## Further information
|
||||||
|
|
||||||
|
For more info on parameters, have a look at the
|
||||||
|
[CPSMS API documentation](https://www.cpsms.dk/login/index.php?page=dokumentation).
|
||||||
|
|
||||||
|
I believe the gateway software running at the CPSMS server is some sort of
|
||||||
standard product. This may be able to talk to other remote SMS gateways as
|
standard product. This may be able to talk to other remote SMS gateways as
|
||||||
well, and that's why I made it an option to specify another gateway base
|
well, and that's why I made it an option to specify another gateway base
|
||||||
URL. If you know of any other compatible gateways, please let me know, and
|
URL. If you know of any other compatible gateways, please let me know, and
|
18
pyproject.toml
Normal file
18
pyproject.toml
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
[project]
|
||||||
|
name = "cpsms"
|
||||||
|
version = "2.1.0"
|
||||||
|
authors = [
|
||||||
|
{ name="Mikkel Munch Mortensen", email="3xm@detfalskested.dk" },
|
||||||
|
]
|
||||||
|
description = "A Python wrapper around the SMS gateway from CPSMS <https://www.cpsms.dk/>."
|
||||||
|
readme = "README.md"
|
||||||
|
requires-python = ">=3.10"
|
||||||
|
classifiers = [
|
||||||
|
"Programming Language :: Python :: 3",
|
||||||
|
"License :: OSI Approved :: MIT License",
|
||||||
|
"Operating System :: OS Independent",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.urls]
|
||||||
|
Homepage = "https://git.data.coop/gorgonzo.la/cpsms"
|
||||||
|
Issues = "https://git.data.coop/gorgonzo.la/cpsms/issues"
|
15
setup.py
15
setup.py
|
@ -1,15 +0,0 @@
|
||||||
from distutils.core import setup
|
|
||||||
|
|
||||||
|
|
||||||
setup(
|
|
||||||
name="cpsms",
|
|
||||||
packages=["cpsms"],
|
|
||||||
version="2.0.3",
|
|
||||||
author="Mikkel Munch Mortensen",
|
|
||||||
author_email="3xm@detfalskested.dk",
|
|
||||||
url="https://github.com/decibyte/cpsms",
|
|
||||||
description=(
|
|
||||||
"A Python wrapper around the SMS gateway from "
|
|
||||||
"CPSMS <https://www.cpsms.dk/>."
|
|
||||||
),
|
|
||||||
)
|
|
Loading…
Reference in a new issue