Kick-start NetLicensing python client library

Author: r-brown

.gitignore

@@ -1,130 +1,39 @@
-# Byte-compiled / optimized / DLL files
+# ── Python ────────────────────────────────────────────────────────────────────
 __pycache__/
 *.py[cod]
+*.pyo
 *$py.class
-
-# C extensions
 *.so
 
-# Distribution / packaging
-.Python
+# ── Build & packaging ─────────────────────────────────────────────────────────
 build/
-develop-eggs/
 dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
 *.egg-info/
-.installed.cfg
 *.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
 
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
+# ── Virtual environments ──────────────────────────────────────────────────────
+.env
+.venv/
+venv/
 
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
+# ── Testing & coverage ────────────────────────────────────────────────────────
 .coverage
 .coverage.*
-.cache
-nosetests.xml
 coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
+htmlcov/
 .pytest_cache/
+.tox/
+.nox/
 
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
+# ── Type checkers ─────────────────────────────────────────────────────────────
 .mypy_cache/
 .dmypy.json
-dmypy.json
-
-# Pyre type checker
 .pyre/
-.vscode
+
+# ── IDE / editor ──────────────────────────────────────────────────────────────
+.idea/
+.vscode/
+
+# ── OS artefacts ──────────────────────────────────────────────────────────────
+.DS_Store
+Thumbs.db

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.0
+
+- Rebuilt the package around a `src/` layout and `pyproject.toml` packaging.
+- Added `httpx`-based `NetLicensingClient` with API-key and username/password authentication.
+- Added typed Pydantic models for core NetLicensing entities.
+- Added services for products, product modules, licensees, license templates, licenses, tokens, transactions, payment methods, bundles, notifications, utility data, and validation.
+- Added deterministic pytest coverage using `httpx.MockTransport`.
+- Added demo CLI for validation and shop-token flows.

CONTRIBUTING.md

@@ -11,34 +11,56 @@
 * Ensure tests are passing
 * Ensure branch is mergeable
 
+## Setup
+
+```bash
+pip install -e ".[dev]"
+```
+
 ## Test
 
 Testing is set up using [pytest](http://pytest.org) and coverage is handled with the pytest-cov plugin.
 
-Run your tests with ```py.test``` in the root directory and please make sure all tests pass.
+Run your tests with:
+
+```bash
+pytest
+```
+
+Coverage is reported in the terminal after each run.
+To view a detailed HTML report open `htmlcov/index.html` after running the tests.
 
-Coverage is ran by default and is set in the ```pytest.ini``` file.
-To see an html output of coverage open ```htmlcov/index.html``` after running the tests.
+To run the optional live integration tests against the NetLicensing demo account:
+
+```bash
+NETLICENSING_LIVE_DEMO=1 pytest tests/test_live_demo.py -q
+```
+
+## Type checking
+
+```bash
+mypy src/netlicensing
+```
 
 ## Release
 
-Install [Twine](https://twine.readthedocs.io):
+Create a source distribution and wheel:
 
 ```bash
-pip install twine
+python -m build
 ```
 
-Create distributions:
+Verify the distribution before uploading:
 
 ```bash
-python setup.py sdist bdist_wheel
+twine check dist/*
 ```
 
-Upload to TestPyPI/PyPI:
+Upload to TestPyPI first, then PyPI:
 
 ```bash
-# Test PyPi
+# Test PyPI
 twine upload -r testpypi dist/*
-# PyPi
+# PyPI
 twine upload dist/*
 ```