Skip to content

Commit c000c58

Browse files
committed
readme: change format from markdown to rst
Fixes issue `twine check` had with markdown code blocks that blocked uploading wheels to pypi. Also, rst files fit better with the python doc environment anyway and more may be added in the future for API documentation purposes.
1 parent a64f7f2 commit c000c58

3 files changed

Lines changed: 61 additions & 48 deletions

File tree

README.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

README.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
|CI| |coverage| |pypi|
2+
3+
===============
4+
pkgcraft-python
5+
===============
6+
7+
Python bindings for pkgcraft_.
8+
9+
Install
10+
=======
11+
12+
Install pre-built package from pypi::
13+
14+
pip install pkgcraft
15+
16+
Install from git (assumes pkgcraft-c has been installed from git and cython is
17+
available)::
18+
19+
pip install https://github.com/pkgcraft/pkgcraft-python/archive/master.tar.gz
20+
21+
Install from a tarball (assumes required release of pkgcraft-c is installed)::
22+
23+
python setup.py install
24+
25+
Development
26+
===========
27+
28+
Requirements: >=python-3.9, tox_, valgrind_, and everything required to build
29+
pkgcraft-c_
30+
31+
Use the following commands to set up a dev environment:
32+
33+
.. code-block:: bash
34+
35+
# clone the pkgcraft workspace and pull the latest project updates
36+
git clone --recurse-submodules https://github.com/pkgcraft/pkgcraft-workspace.git
37+
cd pkgcraft-workspace
38+
git submodule update --recursive --remote
39+
40+
# build pkgcraft-c library and set shell variables (e.g. $PKG_CONFIG_PATH)
41+
source ./build pkgcraft-c
42+
43+
cd pkgcraft-python
44+
# build and test
45+
tox -e python
46+
47+
For development purposes, testing is performed under tox using varying targets
48+
for different functions. Use **tox list** to see all the target descriptions.
49+
50+
.. _tox: https://pypi.org/project/tox/
51+
.. _valgrind: https://valgrind.org/
52+
.. _pkgcraft: https://github.com/pkgcraft/pkgcraft
53+
.. _pkgcraft-c: https://github.com/pkgcraft/pkgcraft-c
54+
55+
.. |CI| image:: https://github.com/pkgcraft/pkgcraft-python/workflows/CI/badge.svg
56+
:target: https://github.com/pkgcraft/pkgcraft-python/actions/workflows/ci.yml
57+
.. |coverage| image:: https://codecov.io/gh/pkgcraft/pkgcraft-python/branch/main/graph/badge.svg
58+
:target: https://codecov.io/gh/pkgcraft/pkgcraft-python
59+
.. |pypi| image:: https://img.shields.io/pypi/v/pkgcraft.svg
60+
:target: https://pypi.python.org/pypi/pkgcraft

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ dynamic = ["version", "readme"]
2121
homepage = "https://github.com/pkgcraft/pkgcraft-python"
2222

2323
[tool.setuptools.dynamic]
24-
readme = {file = ["README.md"]}
24+
readme = {file = ["README.rst"]}
2525

2626
[tool.setuptools.packages.find]
2727
where = ["src"]

0 commit comments

Comments
 (0)