Prepare initial release.

Bump all copyright notices as needed. Update the documentation on how to
install, since a tarball release will soon be available and the package
will be uploaded on PyPI.

docs/conf.py

@@ -3,7 +3,7 @@
 source_suffix = '.rst'
 master_doc = 'index'
 
-copyright = u'2021 Damien Goutte-Gattat'
+copyright = u'2021,2022 Damien Goutte-Gattat'
 author = u'Damien Goutte-Gattat <dpg44@cam.ac.uk>'
 
 language = 'en'

docs/configuration.rst

@@ -53,7 +53,7 @@ Each section must have two keys:
     (e.g., ``https://github.com/gouttegd/grainyhead``), or more simply just the
     name of the GitHub account followed by the name of the repository (e.g.,
     ``gouttegd/grainyhead``).
-    
+
 ``token``
     This is the *personal access token* needed to access the repository through
     the GitHub API. See `GitHub documentation`_ for details on how to obtain

docs/install.rst

@@ -2,23 +2,32 @@
 Installing GrainyHead
 *********************
 
-As of now, GrainyHead is not yet available on the `Python Package Index`_, so
-it has to be installed from source.
+Installing from PyPI
+====================
 
-.. _Python Package Index: https://pypi.org/
+Packages for GrainyHead are published on the `Python Package Index`_ under the
+name ``grainyhead``. To install the latest version from PyPI:
+
+.. _Python Package Index: https://pypi.org/project/grainyhead/
+
+.. code-block:: console
+
+   $ python -m pip install -U grainyhead
 
 
 Installing from source
 ======================
 
-There is no formal release yet, so you need to clone the `Git repository`_:
+You may download a release tarball from the `homepage`_ or from the
+`release page`_, and then proceed to a manual installation:
 
-.. _Git repository: https://github.com/gouttegd/grainyhead
+.. _homepage: https://incenp.org/dvlpt/grainyhead.html
+.. _release page: https://github.com/gouttegd/grainyhead/releases
 
 .. code-block:: console
 
-   $ git clone https://github.com/gouttegd/grainyhead.git
-   $ cd grainyhead
+   $ tar zxf grainyhead-0.1.0.tar.gz
+   $ cd grainyhead-0.1.0
 
 GrainyHead requires the following Python dependencies to work:
 
@@ -39,6 +48,14 @@ Then build a *wheel* package and install it:
    $ python setup.py bdist_wheel
    $ python -m pip install dist/grainyhead-0.1.0-py3-none-any.whl
 
+To install the current development version (tip of the master branch), you may
+either clone locally the repository and then proceed as above, or use *pip* to
+install directly from GitHub:
+
+.. code-block:: console
+
+   $ python -m pip install -U git+https://github.com/gouttegd/grainyhead.git
+
 
 Testing the installation
 ========================
@@ -51,7 +68,7 @@ running the following command:
 
    $ grh --version
    grh (GrainyHead 0.1.0)
-   Copyright © 2021 Damien Goutte-Gattat
+   Copyright © 2022 Damien Goutte-Gattat
 
    This program is released under the GNU General Public License.
    See the COPYING file or <http://www.gnu.org/licenses/gpl.html>.

incenp/grainyhead/main.py

@@ -1,5 +1,5 @@
 # grainyhead - Helper tools for GitHub
-# Copyright © 2021 Damien Goutte-Gattat
+# Copyright © 2021,2022 Damien Goutte-Gattat
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -35,7 +35,7 @@
 prog_name = "grh"
 prog_notice = f"""\
 {prog_name} (GrainyHead {__version__})
-Copyright © 2021 Damien Goutte-Gattat
+Copyright © 2022 Damien Goutte-Gattat
 
 This program is released under the GNU General Public License.
 See the COPYING file or <http://www.gnu.org/licenses/gpl.html>.

incenp/grainyhead/metrics.py

@@ -1,5 +1,5 @@
 # grainyhead - Helper tools for GitHub
-# Copyright © 2021 Damien Goutte-Gattat
+# Copyright © 2021,2022 Damien Goutte-Gattat
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

incenp/grainyhead/providers.py

@@ -1,5 +1,5 @@
 # grainyhead - Helper tools for GitHub
-# Copyright © 2021 Damien Goutte-Gattat
+# Copyright © 2021,2022 Damien Goutte-Gattat
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

incenp/grainyhead/repository.py

@@ -1,5 +1,5 @@
 # grainyhead - Helper tools for GitHub
-# Copyright © 2021 Damien Goutte-Gattat
+# Copyright © 2021,2022 Damien Goutte-Gattat
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

incenp/grainyhead/util.py

@@ -1,5 +1,5 @@
 # grainyhead - Helper tools for GitHub
-# Copyright © 2021 Damien Goutte-Gattat
+# Copyright © 2021,2022 Damien Goutte-Gattat
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

setup.py

@@ -1,5 +1,5 @@
 # grainyhead - Helper tools for GitHub
-# Copyright © 2021 Damien Goutte-Gattat
+# Copyright © 2021,2022 Damien Goutte-Gattat
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -17,17 +17,23 @@
 from setuptools import setup
 from incenp.grainyhead import __version__
 
+with open('README.md', 'r') as fh:
+    long_description = fh.read()
+
 setup(
     name='grainyhead',
     version=__version__,
     description='Helper tools for GitHub',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     author='Damien Goutte-Gattat',
     author_email='dpg44@cam.ac.uk',
     classifiers=[
         'Development Status :: 1 - Planning',
         'Environment :: Console',
-        'Licence :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
-        'Programming Language :: Python :: 3.9'
+        'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
+        'Programming Language :: Python :: 3.9',
+        'Intended Audience :: Developers'
         ],
 
     install_requires=[