register on PyPI

Author: yaozhenghangma

CMakeLists.txt

@@ -1,6 +1,6 @@
 # project
 cmake_minimum_required(VERSION 3.13.0)
-project(hybrid_programming VERSION "0.0.2")
+project(hybrid_programming)
 set(CMAKE_CXX_STANDARD 17)
 
 if(SKBUILD)

README.md

@@ -2,7 +2,8 @@
 
 [![Build Status](https://github.com/YaozhenghangMa/hybrid_programming/actions/workflows/CI.yml/badge.svg?branch=)](https://github.com/YaozhenghangMa/hybrid_programming/actions/workflows/CI.yml?query=branch%3A)
 [![Coverage](https://codecov.io/gh/YaozhenghangMa/hybrid_programming/branch/main/graph/badge.svg)](https://codecov.io/gh/YaozhenghangMa/hybrid_programming)
-[![PyPI](https://img.shields.io/pypi/v/hybrid_programming)](https://pypi.org/project/hybrid_programming/)
+[![PyPI](https://img.shields.io/pypi/v/hybrid_example)](https://pypi.org/project/hybrid_example/)
+[![Documentation Status](https://readthedocs.org/projects/hybrid-programming/badge/?version=latest)](https://hybrid-programming.readthedocs.io/en/latest/?badge=latest)
 ![License](https://img.shields.io/github/license/yaozhenghangma/hybrid_programming)
 
 This package aims to offer tutorials on hybrid programming using C++ and Python. The tutorials cover the following topics:

docs/source/index.md

@@ -7,7 +7,7 @@
 * Multiprocessing via [mpi4py](https://github.com/mpi4py/mpi4py)
 * Continuous integration with [Github Actions](https://github.com/features/actions)
 * Testing with [pytest](https://docs.pytest.org/en/7.3.x/)
-* Register package on [pypi](https://pypi.org)
+* Register package on [PyPI](https://pypi.org)
 * Publish documents on [Read the Docs](https://readthedocs.org)
 
 ## Contents
@@ -17,5 +17,6 @@
    vscode
    scbuild
    github_actions
+   pypi
    api
 ```

docs/source/pypi.md

@@ -0,0 +1,4 @@
+# Register Package on PyPI
+In this section, we will provide a concise tutorial about registering Python package on PyPI. Before registering the package, it's necessary to create an account on PyPI, and obtain an [API token](https://pypi.org/help/#apitoken). The API token should be added to Github repository as a secret named `PYPI_API_TOKEN`.
+
+Subsequently, we can register package when publishing a release with the aid of Github actions. An [example action](https://github.com/yaozhenghangma/hybrid_programming/blob/main/.github/workflows/python-publish.yml) can be found in this repository. In the provided example, the action first packages the code with Scikit-Build, and then conducts a building test with pytest. If the test passes successfully, the action `gh-action-pypi-publish` will take charge of publishing the release to PyPI.

docs/source/scbuild.md

@@ -9,13 +9,14 @@ from skbuild import setup
 An example of `setup.py` can be found [here](https://github.com/yaozhenghangma/hybrid_programming/blob/main/setup.py). The additional options in `setup.py` are listed on [Scikit-Build's website](https://scikit-build.readthedocs.io/en/latest/usage.html#setup-options) and [Python's document](https://docs.python.org/3/distutils/setupscript.html).
 
 ## `pyproject.toml`
-`pyproject.toml` is the specified file format of [PEP 518](https://peps.python.org/pep-0518/), which contains the building system requirements of the project. A detailed description of `pyproject.toml` can be found in [pip's document](https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/). Here, we only utilize a simplified yet practical version that is suitable for most scenarios:
+`pyproject.toml` is the specified file format of [PEP 518](https://peps.python.org/pep-0518/), which contains the dependencies of the project. A detailed description of `pyproject.toml` can be found in [pip's document](https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/). Here, we only utilize a simplified yet practical version that is suitable for most scenarios:
 ```toml
 [build-system]
 requires = [
     "setuptools>=42",
     "cmake>=3.13",
     "scikit-build>=0.14.1",
+    "pybind11>=2.9.2",
 ]
 
 build-backend = "setuptools.build_meta"

setup.py

@@ -14,8 +14,8 @@
 
 setup(
     name="hybrid_example",
-    version="0.0.2",
-    description="Dynamical mean field theory package for material research.",
+    version="0.1.0",
+    description="Tutorials about hybrid programming using C++ and Python",
     author="Yaozhenghang Ma",
     author_email="Yaozhenghang.Ma@gmail.com",
     license="MIT",