Skip to content

Commit

Permalink
Bump version to v1.0.4.
Browse files Browse the repository at this point in the history
  • Loading branch information
ebezzam committed Jun 14, 2023
1 parent e395f7b commit 9fb013e
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 7 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ Bugfix

-

1.0.4 - (2023-06-14)
--------------------

Bugfix
~~~~~~

- Fix rendering of README on PyPI.


1.0.3 - (2023-06-14)
--------------------
Expand Down
14 changes: 11 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,22 +111,30 @@ After merging to the ``main`` branch and from the ``main`` branch (!):
1. Edit the ``lensless/version.py`` file.
2. Update ``CHANGELOG.rst`` with new release version, and create a new
section for ``Unreleased``.
3. Create new tag.
3. Commit and push new version to GitHub.

.. code:: bash
git add lensless/version.py CHANGELOG.rst
git commit -m "Bump version to vX.X.X."
git push origin main
4. Create new tag.

.. code:: bash
git tag -a vX.X.X -m "Description."
git push origin vX.X.X
4. Create package and upload to Pypi (``pip install twine`` if not
5. Create package and upload to Pypi (``pip install twine`` if not
already done).

.. code:: bash
python setup.py sdist
python -m twine upload dist/lensless-X.X.X.tar.gz
5. On `GitHub <https://github.com/LCAV/LenslessPiCam/tags>`__ set the
6. On `GitHub <https://github.com/LCAV/LenslessPiCam/tags>`__ set the
new tag by (1) clicking "…" and selecting "Create release" and (2) at
the bottom pressing "Publish release".

Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ For plotting, you may also need to install
For performing measurements, the expected workflow is to have a local
computer which interfaces remotely with a Raspberry Pi equipped with
the HQ camera sensor (or V2 sensor). Instructions on building the camera
can be found here :ref:`here<Building the camera>`.
can be found `here <https://lensless.readthedocs.io/en/latest/building.html>`__.

The software from this repository has to be installed on **both** your
local machine and the Raspberry Pi. Note that we highly recommend using
Expand Down
2 changes: 1 addition & 1 deletion lensless/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.0.3"
__version__ = "1.0.4"
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
exec(f.read())
assert __version__ is not None

with open("README.rst", "r") as fh:
with open("README.rst", "r", encoding="utf-8") as fh:
long_description = fh.read()

setuptools.setup(
Expand All @@ -16,7 +16,7 @@
author_email="[email protected]",
description="Package to control and image with a lensless camera running on a Raspberry Pi.",
long_description=long_description,
long_description_content_type="text/markdown",
long_description_content_type="text/x-rst",
url="https://github.com/LCAV/LenslessPiCam",
packages=setuptools.find_packages(),
classifiers=[
Expand Down

0 comments on commit 9fb013e

Please sign in to comment.