Add initial code and update skeleton files (#26)

JonoYang · pombredanne · chinyeungli · web-flow · commit 9bc3e436e7b9 · 2025-10-24T13:50:56.000-07:00
* Add skeleton release notes to README.rst This was they do not end up in the template CHANGELOG.rst Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Update format Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add Python 3.9 to Travis Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format and remove spurious spaces From aboutcode-org/typecode#20 Reported-by: Pierre Tardy <pierre.tardy@renault.com> Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Bump to more modern version of setuptools_scm And remove v prefix from fallback version Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add space for correct syntax Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Create junction from Scripts to bin * This is handy for windows to have the same path as linux Signed-off-by: Chin Yeung Li <tli@nexb.com> * Check for deps in local thirdparty directory #31 Signed-off-by: Jono Yang <jyang@nexb.com> * Enforce use of requirements.txt #34 Signed-off-by: Jono Yang <jyang@nexb.com> * Add scripts from scancode-toolkit/etc/release/ #33 Signed-off-by: Jono Yang <jyang@nexb.com> * Normalize license in load_pkginfo_data #33 * Create copyright statement from holder information Signed-off-by: Jono Yang <jyang@nexb.com> * Add --init option to configure #33 * This is used for the case where we are starting off a project and have not yet generated requirements files Signed-off-by: Jono Yang <jyang@nexb.com> * Update README.rst #33 Signed-off-by: Jono Yang <jyang@nexb.com> * Use venv as virtual environment directory name #37 * Replace all references to `tmp` with `venv` Signed-off-by: Jono Yang <jyang@nexb.com> * Update configure.bat #33 * Add --init option to configure.bat * Update help text in configure and configure.bat Signed-off-by: Jono Yang <jyang@nexb.com> * Add placeholder requirements.txt files #33 Signed-off-by: Jono Yang <jyang@nexb.com> * Handle multiple options in configure #33 Signed-off-by: Jono Yang <jyang@nexb.com> * Fix path to aboutcode in utils_thirdparty.py #33 * Update README.rst Signed-off-by: Jono Yang <jyang@nexb.com> * Update release notes in README.rst Signed-off-by: Jono Yang <jyang@nexb.com> * Handle ExpressionParseError #33 * Update README.rst with instructions for post-initialization usage Signed-off-by: Jono Yang <jyang@nexb.com> * Update README.rst Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Address review comments #33 * Replace references to scancode-toolkit repo with links to the skeleton repo * Remove --python option from configure.bat Signed-off-by: Jono Yang <jyang@nexb.com> * Update READMEs Signed-off-by: Jono Yang <jyang@nexb.com> * Fixed #41 - Handled encoding issue when generating ABOUT files Signed-off-by: Chin Yeung Li <tli@nexb.com> * Treat text files as text And not a possible binaries Also Ensure that we craft a minimally parsable license expression, even if not correct. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add helper to publish files in GH releases The upload is otherwise shaky. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add code to use curl if wget is not installed Signed-off-by: Chin Yeung Li <tli@nexb.com> * Do not issue warning if thirdparty dir is missing Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Handle as_text correctly in cache Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Handle as_text correctly in cache Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add support for Python 3.10 Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Adopt black style Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Drop Ubuntu 16 add Python 3.10 Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Disable Python 3.10 tests on macOS 10.14 Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add code to remove the symlink before creating * It will prompts "Cannot create a file when that file already exists." if the symlink already exist. Signed-off-by: Chin Yeung Li <tli@nexb.com> * Improve handling licenses without scancode Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add support for deb and rpm containers Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Support licenses when ScanCode is not installed Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Improve wheel build Allow to launch builds and then fetch built wheels later Improve support for newer Pythons and OS versions. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Aligne with latest ScanCode TK updates Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Do not ignore setup.py Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Update scripts Make fetch_built_wheel work Add new strip classifiers option to fix_thirdparty Improve simple requirements parsing to get the latest versions Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Do not use pytest 7.0.0 which is buggy Reference: pytest-dev/pytest#9608 Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Update `configure` to work with space in installation path Signed-off-by: Chin Yeung Li <tli@nexb.com> * Remove echo statement Signed-off-by: Chin Yeung Li <tli@nexb.com> * automate pypi release on a tag Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com> * Refine GH Action definition * Do not use explicit references to Python version and project name in descriptions * Use Python 3.8 as a base * Use only plain ASCII Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format GH action yaml The indentations were not correct Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Use verbose name for job Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add black codestyle test for skeleton - see aboutcode-org/skeleton#54 Signed-off-by: keshav-space <keshav6240@gmail.com> * Update configure.bat Signed-off-by: Chin Yeung Li <tli@nexb.com> * Deprecate windows-2016 images for azure CI Modifies the azure CI for `vs2017-win2016` to `windows-2022` as the former will be deprecated very soon. * Remove macos 10.14 job from azure-pipelines.yml Signed-off-by: Jono Yang <jyang@nexb.com> * Do not use Python 3.6 on Windows 2022 jobs * Python 3.6 is not available on Windows 2022 images Signed-off-by: Jono Yang <jyang@nexb.com> * Deprecate windows-2016 images for azure CI * Modifies the azure CI for `vs2017-win2016` to `windows-2022` as the former will be deprecated very soon. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Remove macos 10.14 job from azure-pipelines.yml Signed-off-by: Jono Yang <jyang@nexb.com> * Do not use Python 3.6 on Windows 2022 jobs * Python 3.6 is not available on Windows 2022 images Signed-off-by: Jono Yang <jyang@nexb.com> * Run tests on macOS 11 Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Align configuration scripts on POSIX and Windows Doing so helps with keeping them in sync Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Update README Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Refactor and streamline thirdparty utilities There is now a single primary script "fetch_thirdparty.py" that handles everything in a simplified way. There is no utility to build wheels anymore: these MUST be available before hand on PyPI or built manually and uploaded in our self-hosted PyPI repository. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Cleanup whitespaces Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add usage instructions to README.rst Signed-off-by: Jono Yang <jyang@nexb.com> * Format code Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Reorg setup sections This is now organized with more important data first. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Do not depend on click. Use argparse. These boostrap scripts cannot depend on click. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Correct configure scripts These were no longer working Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Remove remnants of configure --init This does not exists anymore Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Pytyon 3.6 is not available on Windows 2022 Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add long_description_content_type Twine and PyPI prefer having it. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Run fewer Azure jobs This new configuration means that all the Python versions are tested in a single CI job. This allows doing fewer checkouts and improves CI throughput overall. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add RTD css templates Adds changes to conf.py and html template theme_overrides.css created by @johnmhoran Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Add GitHub action for doc build tests Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Fix conf.py to fix doc build Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Add docs option in configure Adds a --docs option to the configure script to also install requirements for the documentation builds. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Add documentation contribute page Adds documentation page on contributing to the docs, and also modifies directory structure to avoid having the skeleton directory in docs merged in projects. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Properly check for existance of thirdparty dir Signed-off-by: Jono Yang <jyang@nexb.com> * Improve GH action documentation Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Use Python 3.9 as a base for actions Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Remove variable from string in fetch_thirdparty.py * The variable `environment` is not used when fetching sdists Signed-off-by: Jono Yang <jyang@nexb.com> * Improve thirdparty scripts Ensure that site-package dir exists. Other minor adjustments from a scancode-toolkit release Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Update thirdparty fetching utilities These were buggy in some corner cases. They have been updated such that: * --latest-version works. * we can reliable fetch combinations of wheels and sdists for multiple OS combos at once * we now support macOS universal wheels (for ARM CPUs) Caching is now simpler: we have essentially a single file-based cache under .cache. PyPI indexes are fetched and not cached, unless the new --use-cached-index is used which can be useful when fetching many thirdparty in a short timeframe. The first PyPI repository in a list has precendence and we never fetch from other repositories if we find wheels and sdsists there. This avoid pounding too much on the self-hosted repo. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format code with black Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Only use PyPI for downloads This is much faster Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Enable automatic release on tag Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Remove Travis config Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add ScanCode Code of Conduct Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Improve detection of thirdparty dir Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add comment Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Remove the thirdparty directory Signed-off-by: Chin Yeung Li <tli@nexb.com> * Update the azure-piprlines The following images are deprecated in GitHub actions and Azure DevOps: * `ubuntu-18.04` : actions/runner-images#6002 * `macos-10.15` : actions/runner-images#5583 Due to this there was failing tests due to planned brownouts. Updated ubuntu18 to ubuntu22 Updated macos-1015 to macos12 Signed-off-by: Chin Yeung Li <tli@nexb.com> * Add missing os import in utils_requirements.py * Rename references to etc/release with etc/scripts Signed-off-by: Jono Yang <jyang@nexb.com> * Reinstate Ubuntu 18 and drop Python 3.6 and 3.7 3.7 is not available anymore on newer OSes and is retired in 2023. Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Replace packaging with packvers * import update in src/scripts/utils_dejacode * Packvers replacing packaging in other src/scripts * Added packvers in src/scripts/requirments.txt Signed-off-by: swastik <swastkk@gmail.com> * Ignore egginfo Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Drop Python 3.7 add Python 3.11 Also test on latest Ubuntu and macOS Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Clean .cache and .eggs Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add COC to redistributed license-like files Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add new Makefile Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Align scripts with latest ScanCode Toolkit Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add pycodestyle in setup.cfg Signed-off-by: Arnav Mandal <arnav.mandal1234@gmail.com> * Remove deprecated github-actions/azure images - remove deprecated `ubuntu-18.04` image - remove deprecated `macos-10.15` image Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Pin Sphinx version to 6.2.1 Signed-off-by: Jono Yang <jyang@nexb.com> * Publish PDF version of RTD documentation Made changes in the .readthedocs.yaml to enable format for downloading pdf and epub versions of the documentation and added latex_elements in the conf.py file which generates the pdf without blank pages. The minimum version requirement for sphinx was 6.2.1 which was causing build failure in read the docs, hence changing it 3.3.1 as written in setup.cfg of nexB/aboutcode Signed-off-by: Arijit De <arijitde2050@gmail.com> * Bump github actions versions #75 Update the following actions: * actions/checkout * actions/setup-python Reference: aboutcode-org/skeleton#75 Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Update github actions Reference: aboutcode-org/skeleton#75 Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Update RTD buil Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Fix unordered lists issue Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Add redirects for docs Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Create script to update repo skeleton #80 Signed-off-by: Jono Yang <jyang@nexb.com> * Add macOS-13 job in azure-pipelines.yml Signed-off-by: Jono Yang <jyang@nexb.com> * Added docs server script, dark mode & copybutton for docs Signed-off-by: Omkar Phansopkar <omkarphansopkar@gmail.com> * Update CSS to widen page and handle mobile #84 Reference: aboutcode-org/skeleton#84 Signed-off-by: John M. Horan <johnmhoran@gmail.com> * Delete theme_overrides_SUPERSEDED.css as no longer needed #84 Reference: aboutcode-org/skeleton#84 Signed-off-by: John M. Horan <johnmhoran@gmail.com> * Fix top padding for rst content Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Update CI runners and python version Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Replace deprecated macos CI runners Replace macos-11 runners with macos-14 runners. Reference: https://github.com/actions/runner-images?tab=readme-ov-file#available-images Reference: aboutcode-org/skeleton#89 Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Update minimum required python version to 3.8 Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Update link references of ownership from nexB to aboutcode-org Signed-off-by: Chin Yeung Li <tli@nexb.com> * Drop deprecated macos-12 runner * Update CI/Actions runners Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Replace black and isort with ruff * Use ruff config and Make commands from scancode.io Signed-off-by: Jono Yang <jyang@nexb.com> * Use org standard 100 line length Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Lint all common code directories Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Remove unused targets Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Improve import sorting Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Apply small code updates Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format code Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Apply cosmetic refactorings Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Reformat test code Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format code Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Refine ruff configuration Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format doc Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Run doc8 on all rst files Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Enable doc style checks Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add support for new OS versions Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Update scripts aboutcode references Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Do not format more test data Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Do not treat rst as Python Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Combine testing and docs extra for simplicity Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Refine checking of docs with doc8 Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Refine doc handling * remove CI scripts and use Makefile targets instead * ensure doc8 runs quiet * add new docs-check make target to run documentation and links checks * update oudated doc for docs contribution Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add twine check to release publication Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Refine doc contribution docs Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Replace black and isort with ruff * Use ruff config and Make commands from scancode.io Signed-off-by: Jono Yang <jyang@nexb.com> * Use org standard 100 line length Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Lint all common code directories Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Remove unused targets Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Improve import sorting Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Apply small code updates Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format code Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Apply cosmetic refactorings Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Reformat test code Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format code Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Refine ruff configuration Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format doc Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Run doc8 on all rst files Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Enable doc style checks Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Do not format more test data Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Do not treat rst as Python Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Combine testing and docs extra for simplicity Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Refine checking of docs with doc8 Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Refine doc handling * remove CI scripts and use Makefile targets instead * ensure doc8 runs quiet * add new docs-check make target to run documentation and links checks * update oudated doc for docs contribution Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add twine check to release publication Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Refine doc contribution docs Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Update codestyle command * Remove trailing whitespace Signed-off-by: Jono Yang <jyang@nexb.com> * Update README.rst Signed-off-by: Jono Yang <jyang@nexb.com> * Update BUILDDIR envvar in docs/Makefile Signed-off-by: Jono Yang <jyang@nexb.com> * Fix doc line length Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Format code Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Correct supported runner on Azure See for details: https://learn.microsoft.com/en-us/azure/devops/pipelines/agents/hosted?view=azure-devops&tabs=yaml macOS ARM images do not seem to be supported there Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add code checks to CI Remove running "make check" as a test Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Revert support for Python 3.13 This is not yet supported everywhere Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Ignore local .env file Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add correct extras for documentation Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Improve MANIFEST Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Improve cleaning on POSIX Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Rename dev extra to "dev" Instead of testing ... and update references accordingly Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add more excludes from tests Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Do not lint django migrations Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Add README.rst to list of "license files" Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Use Python 3.9 as lowest suupported version Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Drop pycodestyle Not used anymore Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Bump pytest minimal version Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> * Update CI runners and scripts Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Add missing wheel builds on release CI Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Drop python3.9 support and add python 3.14 Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Support trusted-publishing for package releases Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Update RTD build python version Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> * Add initial code Signed-off-by: Jono Yang <jyang@nexb.com> * Add initial purl map Signed-off-by: Jono Yang <jyang@nexb.com> * Remove functions to create PurlValidator from purl list * This was done for dev purposes Signed-off-by: Jono Yang <jyang@nexb.com> * Remove unnecessary code Signed-off-by: Jono Yang <jyang@nexb.com> * Update comments Signed-off-by: Jono Yang <jyang@nexb.com> * Update AUTHORS.rst Signed-off-by: Jono Yang <jyang@nexb.com> * Update requirements.txt Signed-off-by: Jono Yang <jyang@nexb.com> * Add tests Signed-off-by: Jono Yang <jyang@nexb.com> * Update formatting Signed-off-by: Jono Yang <jyang@nexb.com> --------- Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com> Signed-off-by: Chin Yeung Li <tli@nexb.com> Signed-off-by: Jono Yang <jyang@nexb.com> Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com> Signed-off-by: keshav-space <keshav6240@gmail.com> Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> Signed-off-by: swastik <swastkk@gmail.com> Signed-off-by: Arnav Mandal <arnav.mandal1234@gmail.com> Signed-off-by: Arijit De <arijitde2050@gmail.com> Signed-off-by: Omkar Phansopkar <omkarphansopkar@gmail.com> Signed-off-by: John M. Horan <johnmhoran@gmail.com> Co-authored-by: Philippe Ombredanne <pombredanne@nexb.com> Co-authored-by: Chin Yeung Li <tli@nexb.com> Co-authored-by: Tushar Goel <tushar.goel.dav@gmail.com> Co-authored-by: Philippe Ombredanne <pombredanne@gmail.com> Co-authored-by: keshav-space <keshav6240@gmail.com> Co-authored-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com> Co-authored-by: swastik <swastkk@gmail.com> Co-authored-by: Arnav Mandal <arnav.mandal1234@gmail.com> Co-authored-by: Arijit De <arijitde2050@gmail.com> Co-authored-by: Omkar Phansopkar <omkarphansopkar@gmail.com> Co-authored-by: John M. Horan <johnmhoran@gmail.com> Co-authored-by: Keshav Priyadarshi <git@keshav.space>
diff --git a/.github/workflows/pypi-release.yml b/.github/workflows/pypi-release.yml
@@ -71,6 +71,9 @@ jobs:
     needs:
       - create-gh-release
     runs-on: ubuntu-24.04
+    environment: pypi-publish
+    permissions:
+      id-token: write
 
     steps:
       - name: Download built archives
@@ -82,5 +85,3 @@ jobs:
       - name: Publish to PyPI
         if: startsWith(github.ref, 'refs/tags')
         uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.13"
 
 # Build PDF & ePub
 formats:
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -1,3 +1,5 @@
 The following organizations or individuals have contributed to this repo:
 
--
+- Michael Herzog
+- Philippe Ombredanne
+- Jono Yang
diff --git a/README.rst b/README.rst
@@ -1,15 +1,15 @@
 purl-validator
 ================================
 
-PURLs are everywhere in SBOMs. But with adoption comes widespread errors. 
+PURLs are everywhere in SBOMs. But with adoption comes widespread errors.
 A recent study on the quality of SBOMs revealed that for many proprietary and
-open source tools, PURLs in SBOMs are inconsistent, fake, incorrect, or 
-misleading. This is a serious problem to any application of SBOMs for 
-cybersecurity and application security, as well as related compliance 
-regulations. This project is to create a PURL validator that's decentralized 
+open source tools, PURLs in SBOMs are inconsistent, fake, incorrect, or
+misleading. This is a serious problem to any application of SBOMs for
+cybersecurity and application security, as well as related compliance
+regulations. This project is to create a PURL validator that's decentralized
 such that libraries can use it offline and help them create better PURLs.
 
-Building this compact dataset is new territory. There is research 
-and exploration necessary for creating a super compact data structure 
-that is also easy and fast to query across multiple languages. The data 
+Building this compact dataset is new territory. There is research
+and exploration necessary for creating a super compact data structure
+that is also easy and fast to query across multiple languages. The data
 structure will also need memory-mapping to avoid running out of memory.
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -19,54 +19,54 @@ jobs:
       parameters:
           job_name: ubuntu22_cpython
           image_name: ubuntu-22.04
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.10', '3.11', '3.12', '3.13', '3.14']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: ubuntu24_cpython
           image_name: ubuntu-24.04
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.10', '3.11', '3.12', '3.13', '3.14']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: macos13_cpython
           image_name: macOS-13
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.10', '3.11', '3.12', '3.13', '3.14']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: macos14_cpython
           image_name: macOS-14
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.10', '3.11', '3.12', '3.13', '3.14']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: macos15_cpython
           image_name: macOS-15
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.10', '3.11', '3.12', '3.13', '3.14']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
     - template: etc/ci/azure-win.yml
       parameters:
           job_name: win2022_cpython
           image_name: windows-2022
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.10', '3.11', '3.12', '3.13', '3.14']
           test_suites:
               all: venv\Scripts\pytest -n 2 -vvs
 
     - template: etc/ci/azure-win.yml
       parameters:
           job_name: win2025_cpython
           image_name: windows-2025
-          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          python_versions: ['3.10', '3.11', '3.12', '3.13', '3.14']
           test_suites:
               all: venv\Scripts\pytest -n 2 -vvs
diff --git a/etc/scripts/utils_requirements.py b/etc/scripts/utils_requirements.py
@@ -153,7 +153,7 @@ def split_req(req):
     if not req:
         raise ValueError("req is required")
     # do not allow multiple constraints and tags
-    if not any(c in req for c in ",;"):
+    if any(c in req for c in ",;"):
         raise Exception(f"complex requirements with : or ; not supported: {req}")
     req = "".join(req.split())
     if not any(c in req for c in comparators):
diff --git a/etc/scripts/utils_thirdparty.py b/etc/scripts/utils_thirdparty.py
@@ -115,14 +115,14 @@
 TRACE_ULTRA_DEEP = False
 
 # Supported environments
-PYTHON_VERSIONS = "39", "310", "311", "312", "313"
+PYTHON_VERSIONS = "310", "311", "312", "313", "314"
 
 PYTHON_DOT_VERSIONS_BY_VER = {
-    "39": "3.9",
     "310": "3.10",
     "311": "3.11",
     "312": "3.12",
     "313": "3.13",
+    "314": "3.14",
 }
 
 
@@ -134,11 +134,11 @@ def get_python_dot_version(version):
 
 
 ABIS_BY_PYTHON_VERSION = {
-    "39": ["cp39", "cp39m", "abi3"],
     "310": ["cp310", "cp310m", "abi3"],
     "311": ["cp311", "cp311m", "abi3"],
     "312": ["cp312", "cp312m", "abi3"],
     "313": ["cp313", "cp313m", "abi3"],
+    "314": ["cp314", "cp314m", "abi3"],
 }
 
 PLATFORMS_BY_OS = {
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools >= 50", "wheel", "setuptools_scm[toml] >= 6"]
+requires = ["setuptools >= 50", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
@@ -68,7 +68,7 @@ include = [
   "."
 
 ]
-# ignore test data and testfiles: they should never be linted nor formatted 
+# ignore test data and testfiles: they should never be linted nor formatted
 exclude = [
 # main style
   "**/tests/data/**/*",
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -0,0 +1,65 @@
+aboutcode-toolkit==11.1.1
+alabaster==1.0.0
+anyio==4.11.0
+babel==2.17.0
+boolean.py==5.0
+cffi==2.0.0
+colorama==0.4.6
+cryptography==46.0.3
+doc8==2.0.0
+docutils==0.21.2
+et_xmlfile==2.0.0
+execnet==2.1.1
+h11==0.16.0
+id==1.5.0
+imagesize==1.4.1
+iniconfig==2.3.0
+jaraco.classes==3.4.0
+jaraco.context==6.0.1
+jaraco.functools==4.3.0
+jeepney==0.9.0
+jinja2==3.1.6
+keyring==25.6.0
+license-expression==30.4.4
+markdown-it-py==4.0.0
+markupsafe==3.0.3
+mdurl==0.1.2
+more-itertools==10.8.0
+nh3==0.3.1
+openpyxl==3.1.5
+packageurl-python==0.17.5
+packaging==25.0
+pluggy==1.6.0
+pycparser==2.23
+pygments==2.19.2
+pytest==8.4.2
+pytest-xdist==3.8.0
+readme_renderer==44.0
+requests-toolbelt==1.0.0
+restructuredtext_lint==1.4.0
+rfc3986==2.0.0
+rich==14.2.0
+roman-numerals-py==3.1.0
+ruff==0.14.2
+secretstorage==3.4.0
+sniffio==1.3.1
+snowballstemmer==3.0.1
+sphinx==8.2.3
+sphinx-autobuild==2025.8.25
+sphinx-copybutton==0.5.2
+sphinx-reredirects==1.0.0
+sphinx-rtd-dark-mode==1.3.0
+sphinx-rtd-theme==3.0.2
+sphinxcontrib-applehelp==2.0.0
+sphinxcontrib-devhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
+sphinxcontrib-jquery==4.1
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==2.0.0
+sphinxcontrib-serializinghtml==2.0.0
+starlette==0.48.0
+stevedore==5.5.0
+twine==6.2.0
+uvicorn==0.38.0
+watchfiles==1.1.1
+websockets==15.0.1
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,18 @@
+attrs==25.4.0
+beautifulsoup4==4.14.2
+certifi==2025.10.5
+chardet==5.2.0
+charset-normalizer==3.4.4
+click==8.3.0
+commoncode==32.4.0
+ducer==1.2.0
+idna==3.11
+pip==25.2
+PyYAML==6.0.3
+requests==2.32.5
+saneyaml==0.6.1
+setuptools==80.9.0
+soupsieve==2.8
+text-unidecode==1.3
+typing_extensions==4.15.0
+urllib3==2.5.0
diff --git a/setup.cfg b/setup.cfg
@@ -1,12 +1,12 @@
 [metadata]
-name = skeleton
+name = purl-validator
 license = Apache-2.0
 
 # description must be on ONE line https://github.com/pypa/setuptools/issues/1390
-description = skeleton
+description = purl-validator
 long_description = file:README.rst
 long_description_content_type = text/x-rst
-url = https://github.com/aboutcode-org/skeleton
+url = https://github.com/aboutcode-org/purl-validator
 
 author = nexB. Inc. and others
 author_email = info@aboutcode.org
@@ -31,7 +31,7 @@ license_files =
     README.rst
 
 [options]
-python_requires = >=3.9
+python_requires = >=3.10
 
 package_dir =
     =src
@@ -43,6 +43,8 @@ setup_requires = setuptools_scm[toml] >= 4
 
 
 install_requires =
+    commoncode
+    ducer
 
 
 [options.packages.find]
diff --git a/src/README.rst b/src/README.rst
diff --git a/src/__init__.py b/src/__init__.py
diff --git a/src/purl_validator/__init__.py b/src/purl_validator/__init__.py
@@ -0,0 +1,94 @@
+#
+# Copyright (c) nexB Inc. and others.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Visit https://aboutcode.org and https://github.com/aboutcode-org/ for support and download.
+# ScanCode is a trademark of nexB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from pathlib import Path
+import mmap
+
+from commoncode import fileutils
+from packageurl import PackageURL
+import ducer
+
+
+PURL_MAP_LOCATION = Path(__file__).parent / "purls.map"
+
+
+def create_purl_map_entry(purl):
+    """
+    Given a `purl` that is a PackageURL proper or a string representation of
+    one, return a bytestring containing the type, namespace (if available), and
+    name of the package from `purl`.
+    """
+    if not isinstance(purl, (PackageURL, str)):
+        raise ValueError(f"invalid `purl`: {purl}")
+
+    # Ensure `purl` is a PackageURL
+    if isinstance(purl, str):
+        p = PackageURL.from_string(purl)
+    else:
+        p = purl
+
+    # Create purl map entry string
+    if p.namespace:
+        purl_str = f"{p.type}/{p.namespace}/{p.name}"
+    else:
+        purl_str = f"{p.type}/{p.name}"
+
+    # Convert purl map entry string to bytes
+    return bytes(purl_str, "utf-8")
+
+
+def create_purl_map(purls):
+    """
+    Given an iterable of `purls`, that can be either PackageURLs proper or
+    strings representing them, return a Ducer map that contains strings created
+    from the type, namespace (if available), and name of the packages from
+    `purls`.
+    """
+    # purl map entries must be unique, sorted, and converted to bytes before going into the Map
+    purl_map_entries = set(create_purl_map_entry(purl) for purl in purls)
+    prepared_purl_map_entries = sorted((purl_map_entry, 1) for purl_map_entry in purl_map_entries)
+
+    # create map
+    temp_dir = fileutils.get_temp_dir()
+    map_loc = Path(temp_dir) / "purls.map"
+    ducer.Map.build(map_loc, prepared_purl_map_entries)
+
+    return map_loc
+
+
+class PurlValidator:
+    def __init__(self, purl_map_loc=PURL_MAP_LOCATION):
+        self.purl_map = self.load_map(location=purl_map_loc)
+
+    @classmethod
+    def load_map(cls, location):
+        with open(location, "rb") as f:
+            mm = mmap.mmap(f.fileno(), 0, access=mmap.ACCESS_READ)
+        m = ducer.Map(mm)
+        return m
+
+    def validate_purl(self, purl):
+        """
+        Given a `purl` that is a PackageURL proper or a string representation of
+        one, return True if `purl` exists, False otherwise.
+        """
+        purl_map_entry = create_purl_map_entry(purl)
+        in_purl_map = bool(self.purl_map.get(purl_map_entry))
+        return in_purl_map
diff --git a/src/purl_validator/purls.map b/src/purl_validator/purls.map
diff --git a/tests/README.rst b/tests/README.rst
diff --git a/tests/test_purl_validator.py b/tests/test_purl_validator.py
