{"id":34048525,"url":"https://github.com/nthparty/bcl","last_synced_at":"2026-04-08T19:31:18.519Z","repository":{"id":49958536,"uuid":"322159142","full_name":"nthparty/bcl","owner":"nthparty","description":"Python library that provides a simple interface for symmetric (i.e., secret-key) and asymmetric (i.e., public-key) encryption/decryption primitives.","archived":false,"fork":false,"pushed_at":"2025-10-21T21:05:22.000Z","size":44180,"stargazers_count":3,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-02T21:03:00.679Z","etag":null,"topics":["cryptography-library","public-key-cryptography","public-key-encryption","python-cryptography","python-encryption","python-library","secret-key-encryption"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/bcl","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nthparty.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-12-17T02:38:03.000Z","updated_at":"2025-09-28T23:44:23.000Z","dependencies_parsed_at":"2023-02-07T16:01:21.538Z","dependency_job_id":"e9afb455-8aec-424d-a3dd-205f47685e26","html_url":"https://github.com/nthparty/bcl","commit_stats":{"total_commits":206,"total_committers":6,"mean_commits":"34.333333333333336","dds":"0.34466019417475724","last_synced_commit":"e947a740a19889c32954878a8ebf302d192353d0"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/nthparty/bcl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nthparty%2Fbcl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nthparty%2Fbcl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nthparty%2Fbcl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nthparty%2Fbcl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nthparty","download_url":"https://codeload.github.com/nthparty/bcl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nthparty%2Fbcl/sbom","scorecard":{"id":697693,"data":{"date":"2025-08-11","repo":{"name":"github.com/nthparty/bcl","commit":"b654246df2124385b226f02a60ba6b9222cb1c94"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/lint-test-cover-docs-build-upload.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:125: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:141: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:182: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:205: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:207: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:252: update your workflow using https://app.stepsecurity.io/secureworkflow/nthparty/bcl/lint-test-cover-docs-build-upload.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:31","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:42","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:45","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:51","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:59","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:97","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:107","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:110","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:116","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:154","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:164","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:167","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:173","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:218","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:230","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:234","Warn: pipCommand not pinned by hash: .github/workflows/lint-test-cover-docs-build-upload.yml:241","Info:   0 out of  10 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  17 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-22T04:12:50.123Z","repository_id":49958536,"created_at":"2025-08-22T04:12:50.123Z","updated_at":"2025-08-22T04:12:50.123Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31571599,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cryptography-library","public-key-cryptography","public-key-encryption","python-cryptography","python-encryption","python-library","secret-key-encryption"],"created_at":"2025-12-14T00:05:33.288Z","updated_at":"2026-04-08T19:31:18.511Z","avatar_url":"https://github.com/nthparty.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"===\nbcl\n===\n\nPython library that provides a simple interface for symmetric (*i.e.*, secret-key) and asymmetric (*i.e.*, public-key) encryption/decryption primitives.\n\n|pypi| |readthedocs| |actions| |coveralls|\n\n.. |pypi| image:: https://badge.fury.io/py/bcl.svg#\n   :target: https://badge.fury.io/py/bcl\n   :alt: PyPI version and link.\n\n.. |readthedocs| image:: https://readthedocs.org/projects/bcl/badge/?version=latest\n   :target: https://bcl.readthedocs.io/en/latest/?badge=latest\n   :alt: Read the Docs documentation status.\n\n.. |actions| image:: https://github.com/nthparty/bcl/workflows/build-lint-test-cover-docs-upload/badge.svg#\n   :target: https://github.com/nthparty/bcl/actions\n   :alt: GitHub Actions status.\n\n.. |coveralls| image:: https://coveralls.io/repos/github/nthparty/bcl/badge.svg?branch=main\n   :target: https://coveralls.io/github/nthparty/bcl?branch=main\n   :alt: Coveralls test coverage summary.\n\nPurpose\n-------\nThis library provides simple and straightforward methods for symmetric (*i.e.*, secret-key) and asymmetric (*i.e.*, public-key) cryptographic encryption and decryption capabilities. The library's interface is designed for ease of use and therefore hides from users some of the flexibilities and performance trade-offs that can be leveraged via direct use of the underlying cryptographic libraries.\n\nThe library's name is a reference to `boron trichloride \u003chttps://en.wikipedia.org/wiki/Boron_trichloride\u003e`__, as it is a wrapper and binding for a limited set of capabilities found in `libsodium \u003chttps://doc.libsodium.org\u003e`__. However, it can also be an acronym for *basic cryptographic library*.\n\nInstallation and Usage\n----------------------\nThis library is available as a `package on PyPI \u003chttps://pypi.org/project/bcl\u003e`__:\n\n.. code-block:: bash\n\n    python -m pip install bcl\n\nThe library can be imported in the usual manner:\n\n.. code-block:: python\n\n    import bcl\n    from bcl import *\n\nExamples\n^^^^^^^^\n\n.. |symmetric| replace:: symmetric\n.. _symmetric: https://bcl.readthedocs.io/en/3.0.0/_source/bcl.html#bcl.bcl.symmetric\n\nThis library provides concise methods for implementing |symmetric|_ encryption workflows:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e from bcl import symmetric\n    \u003e\u003e\u003e s = symmetric.secret() # Generate a secret key.\n    \u003e\u003e\u003e c = symmetric.encrypt(s, 'abc'.encode())\n    \u003e\u003e\u003e symmetric.decrypt(s, c).decode('utf-8')\n    'abc'\n\n.. |Asymmetric| replace:: Asymmetric\n.. _Asymmetric: https://bcl.readthedocs.io/en/3.0.0/_source/bcl.html#bcl.bcl.asymmetric\n\n|Asymmetric|_ encryption workflows are also supported:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e from bcl import asymmetric\n    \u003e\u003e\u003e s = asymmetric.secret() # Generate a secret key.\n    \u003e\u003e\u003e p = asymmetric.public(s) # Generate a corresponding public key.\n    \u003e\u003e\u003e c = asymmetric.encrypt(p, 'abc'.encode())\n    \u003e\u003e\u003e asymmetric.decrypt(s, c).decode('utf-8')\n    'abc'\n\n.. |keys| replace:: keys\n.. _keys: https://bcl.readthedocs.io/en/3.0.0/_source/bcl.html#bcl.bcl.key\n\n.. |secret| replace:: secret\n.. _secret: https://bcl.readthedocs.io/en/3.0.0/_source/bcl.html#bcl.bcl.secret\n\n.. |public| replace:: public\n.. _public: https://bcl.readthedocs.io/en/3.0.0/_source/bcl.html#bcl.bcl.public\n\n.. |nonces| replace:: nonces\n.. _nonces: https://bcl.readthedocs.io/en/3.0.0/_source/bcl.html#bcl.bcl.nonce\n\n.. |plaintexts| replace:: plaintexts\n.. _plaintexts: https://bcl.readthedocs.io/en/3.0.0/_source/bcl.html#bcl.bcl.plain\n\n.. |ciphertexts| replace:: ciphertexts\n.. _ciphertexts: https://bcl.readthedocs.io/en/3.0.0/_source/bcl.html#bcl.bcl.cipher\n\nThis library also provides a number of classes for representing |keys|_ (|secret|_ and |public|_), |nonces|_, |plaintexts|_, and |ciphertexts|_. All methods expect and return instances of the appropriate classes:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e from bcl import secret, public, cipher\n    \u003e\u003e\u003e s = asymmetric.secret()\n    \u003e\u003e\u003e isinstance(s, secret)\n    True\n    \u003e\u003e\u003e p = asymmetric.public(s)\n    \u003e\u003e\u003e isinstance(p, public)\n    True\n    \u003e\u003e\u003e c = symmetric.encrypt(s, 'abc'.encode())\n    \u003e\u003e\u003e type(c)\n    \u003cclass 'bcl.bcl.cipher'\u003e\n    \u003e\u003e\u003e symmetric.decrypt(bytes(s), c)\n    Traceback (most recent call last):\n      ...\n    TypeError: can only decrypt using a symmetric secret key\n    \u003e\u003e\u003e symmetric.decrypt(s, bytes(c))\n    Traceback (most recent call last):\n      ...\n    TypeError: can only decrypt a ciphertext\n\n.. |bytes| replace:: ``bytes``\n.. _bytes: https://docs.python.org/3/library/stdtypes.html#bytes\n\nFurthermore, the above classes are derived from |bytes|_, so `all methods and other operators \u003chttps://docs.python.org/3/library/stdtypes.html#bytes\u003e`__ supported by |bytes|_ objects are supported:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e p.hex()\n    '0be9cece7fee92809908bd14666eab96b77deebb488c738445d842a6613b7b48'\n\nIn addition, Base64 conversion methods are included for all of the above classes to support concise encoding and decoding of objects:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e p.to_base64()\n    'C+nOzn/ukoCZCL0UZm6rlrd97rtIjHOERdhCpmE7e0g='\n    \u003e\u003e\u003e b = 'C+nOzn/ukoCZCL0UZm6rlrd97rtIjHOERdhCpmE7e0g='\n    \u003e\u003e\u003e type(public.from_base64(b))\n    \u003cclass 'bcl.bcl.public'\u003e\n\nDevelopment, Build, and Manual Installation Instructions\n--------------------------------------------------------\nAll development and installation dependencies are managed using `setuptools \u003chttps://pypi.org/project/setuptools\u003e`__ and are fully specified in ``setup.cfg``. The ``extras_require`` option is used to `specify optional requirements \u003chttps://setuptools.pypa.io/en/latest/userguide/dependency_management.html#optional-dependencies\u003e`__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip \u003chttps://pypi.org/project/pip\u003e`__ (assuming that the library has already been built successfully):\n\n.. code-block:: bash\n\n    python -m pip install \".[docs,lint]\"\n\nBuilding from Source\n^^^^^^^^^^^^^^^^^^^^\nThe library can be built manually from source **within Linux and macOS** using the sequence of commands below:\n\n.. code-block:: bash\n\n    python -m pip install \".[build]\"\n    python -m build --sdist --wheel .\n\nDeveloping the library further in a local environment and/or building the library from source requires `libsodium \u003chttps://doc.libsodium.org\u003e`__. The step ``python -m build --sdist --wheel .`` in the above attempts to automatically locate a copy of the libsodium source archive ``src/bcl/libsodium.tar.gz``. If the archive corresponding to the operating system is not found, the build process attempts to download it. To support building offline, it is necessary to first download the appropriate libsodium archive to its designated location:\n\n.. code-block:: bash\n\n    wget -O src/bcl/libsodium.tar.gz https://github.com/jedisct1/libsodium/releases/download/1.0.18-RELEASE/libsodium-1.0.18.tar.gz\n\nThe process for building manually from source within a Windows environment is not currently documented, but an example of one sequence of steps can be found in the Windows job entry within the GitHub Actions workflow defined in the file ``.github/workflows/build-lint-test-cover-docs-upload.yml``.\n\nPreparation for Local Development\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nBefore `documentation can be generated \u003c#documentation\u003e`_ or `tests can be executed \u003c#testing-and-conventions\u003e`_, it is necessary to `run the build process \u003c#building-from-source\u003e`_ and then to use the command below to move the compiled libsodium shared/dynamic library file into its designated location (so that the module file ``src/bcl/bcl.py`` is able to import it):\n\n.. code-block:: bash\n\n    cp build/lib*/bcl/_sodium.py src/bcl\n\nManual Installation\n^^^^^^^^^^^^^^^^^^^\nOnce the package is `built \u003c#building-from-source\u003e`_, it can be installed manually using the command below:\n\n.. code-block:: bash\n\n    python -m pip install -f dist . --upgrade\n\nDocumentation\n^^^^^^^^^^^^^\nOnce the libsodium shared library file is compiled and moved into its designated location (as described in `the relevant subsection above \u003c#preparation-for-local-development\u003e`_), the documentation can be generated automatically from the source files using `Sphinx \u003chttps://www.sphinx-doc.org\u003e`__:\n\n.. code-block:: bash\n\n    python -m pip install \".[docs]\"\n    cd docs\n    sphinx-apidoc -f -E --templatedir=_templates -o _source .. ../src/bcl/_sodium_build.py \u0026\u0026 make html\n\nTesting and Conventions\n^^^^^^^^^^^^^^^^^^^^^^^\nBefore unit tests can be executed, it is first necessary to prepare for local development by compiling and moving into its designated location the libsodium shared library file (as described in `the relevant subsection above \u003c#preparation-for-local-development\u003e`__).\n\nAll unit tests are executed and their coverage is measured when using `pytest \u003chttps://docs.pytest.org\u003e`__ (see ``pyproject.toml`` for configuration details):\n\n.. code-block:: bash\n\n    python -m pip install \".[test]\"\n    python -m pytest\n\nAlternatively, all unit tests are included in the module itself and can be executed using `doctest \u003chttps://docs.python.org/3/library/doctest.html\u003e`__:\n\n.. code-block:: bash\n\n    python src/bcl/bcl.py -v\n\nStyle conventions are enforced using `Pylint \u003chttps://pylint.readthedocs.io\u003e`__:\n\n.. code-block:: bash\n\n    python -m pip install \".[lint]\"\n    python -m pylint src/bcl src/bcl/_sodium.tmpl src/bcl/_sodium_build.py --disable=duplicate-code\n\nContributions\n^^^^^^^^^^^^^\nIn order to contribute to the source code, open an issue or submit a pull request on the `GitHub page \u003chttps://github.com/nthparty/bcl\u003e`__ for this library.\n\nVersioning\n^^^^^^^^^^\nThe version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 \u003chttps://semver.org/#semantic-versioning-200\u003e`__.\n\nPublishing\n^^^^^^^^^^\nThis library can be published as a `package on PyPI \u003chttps://pypi.org/project/bcl\u003e`__ via the GitHub Actions workflow found in ``.github/workflows/build-publish-sign-release.yml`` that follows the `recommendations found in the Python Packaging User Guide \u003chttps://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/\u003e`__.\n\nEnsure that the correct version number appears in ``setup.cfg``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule \u003chttps://docs.readthedocs.io/en/stable/automation-rules.html\u003e`__ that activates and sets as the default all tagged versions.\n\nTo publish the package, create and push a tag for the version being published (replacing ``?.?.?`` with the version number):\n\n.. code-block:: bash\n\n    git tag ?.?.?\n    git push origin ?.?.?\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnthparty%2Fbcl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnthparty%2Fbcl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnthparty%2Fbcl/lists"}