Merge pull request #11 from LedgerHQ/fix/pythonic-version

fix: removing generated files from gconf

Author: pthierry-ledger

.github/workflows/ci.yml

@@ -19,7 +19,9 @@ jobs:
       - run: |
           pip install tox
       - name: Run linters
-        run: tox -e build || true
+        run: |
+          tox -e genproto
+          tox -e build || true
 
   test:
     runs-on: ubuntu-latest
@@ -38,7 +40,9 @@ jobs:
       - run: |
           pip install tox
       - name: Run unittests
-        run: tox -e unittests
+        run: |
+          tox -e genproto
+          tox -e unittests
 
   lint:
     runs-on: ubuntu-latest
@@ -51,7 +55,9 @@ jobs:
       - run: |
           pip install tox
       - name: Run linters
-        run: tox -e lint || true
+        run: |
+          tox -e genproto
+          tox -e lint || true
 
   doc:
     runs-on: ubuntu-latest
@@ -64,4 +70,6 @@ jobs:
       - run: |
           pip install tox
       - name: Run linters
-        run: tox -e doc
+        run: |
+          tox -e genproto
+          tox -e doc

.github/workflows/publish.yml

@@ -19,6 +19,7 @@ jobs:
           python-version: '3.10'
       - run: |
           pip install tox
+          tox -e genproto
           tox -e build
       # initiate jfrog login and install jf
       - name: Login to JFrog Ledger

README.rst

@@ -30,7 +30,29 @@ If you're interested in using this library, please get involved.
 * Free software: Apache Software License 2.0
 * Documentation: https://python-etcd3.readthedocs.io.
 
-Basic usage:
+
+Building python package
+-----------------------
+
+The package build is made using the ToX orchestrator.
+It is required to generate python files before building the package as they are
+not kept in gconf.
+You only need the ToX orchestrator to produce the package:
+
+```
+pip install tox
+```
+
+A typical build sequence is the folling:
+
+```
+tox -e genproto
+tox -e build
+```
+
+
+Basic usage
+-----------
 
 .. code-block:: python
 

pyproject.toml

@@ -8,7 +8,6 @@ description = "Python client for the etcd3 API"
 dynamic = ["version"]
 requires-python = ">=3.7"
 readme = "README.rst"
-license = {file = "LICENSE"}
 authors = [
   {email = "Louis Taylor <louis@kragniz.eu>"},
   {email = "Ledger SAS <team-embedded-software+enclave@ledger.fr>"},
@@ -21,7 +20,6 @@ dependencies = [
 classifiers = [
     "Development Status :: 2 - Pre-Alpha",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: Apache Software License",
     "Natural Language :: English",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",