-
Notifications
You must be signed in to change notification settings - Fork 213
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Switch from setuptools to a modern pyproject config #158
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,4 @@ | ||
SMART FHIR Client | ||
================= | ||
# SMART FHIR Client | ||
|
||
This is _fhirclient_, a flexible Python client for [FHIR][] servers supporting the [SMART on FHIR][smart] protocol. | ||
|
||
|
@@ -22,14 +21,12 @@ The `develop` branch should be on recent freezes, and the `feature/latest-ci` br | |
**0.0.2** | `0.0.82.2943` | (DSTU 1) | ||
|
||
|
||
Installation | ||
------------ | ||
## Installation | ||
|
||
pip install fhirclient | ||
|
||
|
||
Documentation | ||
------------- | ||
## Documentation | ||
|
||
Technical documentation is available at [docs.smarthealthit.org/client-py/][docs]. | ||
|
||
|
@@ -170,23 +167,19 @@ Clone the _client-py_ repository, then create a virtual environment (not compuls | |
python flask_app.py | ||
|
||
|
||
Building Distribution | ||
--------------------- | ||
## Building Distribution | ||
|
||
pip install -r requirements.txt | ||
python setup.py sdist | ||
python setup.py bdist_wheel | ||
pip install -U build | ||
python3 -m build | ||
|
||
|
||
### Incrementing the lib version | ||
|
||
bumpversion patch | ||
bumpversion minor | ||
bumpversion major | ||
- Edit `fhirclient/client.py` and change the `__version__` field. | ||
- Edit `Doxyfile` and change the `PROJECT_NUMBER` field. | ||
|
||
|
||
Docs Generation | ||
--------------- | ||
## Docs Generation | ||
|
||
Docs are generated with [Doxygen][] and [doxypypy][]. | ||
You can install doxypypy via pip: `pip install doxypypy`. | ||
|
@@ -200,24 +193,22 @@ I usually perform a second checkout of the _gh-pages_ branch and copy the html f | |
rsync -a docs/html/ ../client-py-web/ | ||
|
||
|
||
PyPi Publishing (notes for SMART team) | ||
-------------------------------------- | ||
## PyPi Publishing (notes for SMART team) | ||
|
||
Using setuptools (*Note*: Alternatively, you can use twine https://pypi.python.org/pypi/twine/): | ||
Using flit (*Note*: Alternatively, you can use [twine](https://twine.readthedocs.io/)): | ||
|
||
### Make sure that you have the PyPi account credentials in your account | ||
|
||
copy server.smarthealthit.org:/home/fhir/.pypirc to ~/.pypirc | ||
|
||
### Test the build | ||
|
||
python setup.py sdist | ||
python setup.py bdist_wheel | ||
python3 -m build | ||
Comment on lines
-214
to
+206
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I tested the resulting sdist & and bdist from the new approach vs the old tarballs - new ones are still good. |
||
|
||
### Upload the packages to PyPi | ||
|
||
python setup.py sdist upload -r pypi | ||
python setup.py bdist_wheel upload -r pypi | ||
pip install -U flit | ||
flit publish | ||
|
||
|
||
[fhir]: http://www.hl7.org/implement/standards/fhir/ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
"""A flexible client for FHIR servers supporting the SMART on FHIR protocol""" | ||
|
||
from .client import __version__ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
[project] | ||
name = "fhirclient" | ||
requires-python = ">= 3.8" | ||
dependencies = [ | ||
"isodate >= 0.5", | ||
"requests >= 2.4", | ||
] | ||
authors = [{ name="SMART Platforms Team", email="[email protected]" }] | ||
readme = "README.md" | ||
keywords = ["smart", "fhir", "healthcare", "medical-informatics", "clinical-informatics", "biomedical-informatics"] | ||
license = { file="LICENSE" } | ||
classifiers = [ | ||
"Development Status :: 5 - Production/Stable", | ||
"Intended Audience :: Developers", | ||
"Natural Language :: English", | ||
"License :: OSI Approved :: Apache Software License", | ||
"Operating System :: OS Independent", | ||
"Programming Language :: Python", | ||
"Programming Language :: Python :: 3", | ||
"Topic :: Software Development :: Libraries :: Python Modules", | ||
] | ||
dynamic = ["description", "version"] | ||
|
||
[project.urls] | ||
Homepage = "https://github.com/smart-on-fhir/client-py" | ||
Documentation = "https://docs.smarthealthit.org/client-py/" | ||
|
||
[build-system] | ||
requires = ["flit_core >=3.4,<4"] | ||
build-backend = "flit_core.buildapi" | ||
|
||
[project.optional-dependencies] | ||
tests = [ | ||
"pytest >= 2.5", | ||
"pytest-cov", | ||
] |
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We had a mix of underline and ## headers - consolidating on hashes, which are more obvious about what level you're at.