Install phylum

CHANGELOG.md

@@ -6,6 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 ### Added
+* `phylum-init` script entry point and initial functionality
 * Test workflows for local and CI based testing
 * Preview and Release workflows for Staging and Production environments
 * Phylum analyze workflow for PRs

CONTRIBUTING.md

@@ -36,7 +36,7 @@ Look through the GitHub issues for features to work on, which will be labeled wi
 ### Write Documentation
 
 The `phylum-ci` project could always use more documentation, whether as part of the
-official phylum-ci docs, in docstrings, or even on the web in blog posts, articles, and such.
+official phylum docs, in docstrings, or even on the web in blog posts, articles, and such.
 
 ### Submit Feedback
 
@@ -144,11 +144,20 @@ interact with `pytest` by passing additional positional arguments:
 
 ```sh
 # run a specific test module across all test environments
-poetry run tox tests/test_phylum_ci.py
+poetry run tox tests/test_package_metadata.py
 # run a specific test module across a specific test environment
-poetry run tox -e py39 test/test_phylum_ci.py
+poetry run tox -e py39 test/test_package_metadata.py
 # run a specific test function within a test module, in a specific test environment
-poetry run tox -e py310 test/test_phylum_ci.py::test_python_version
+poetry run tox -e py310 test/test_package_metadata.py::test_python_version
 # passing additional options to pytest requires using the double dash escape
 poetry run tox -e py310 -- --help
 ```
+
+To run a script entry point with the local checkout of the code (in develop mode), use `poetry`:
+
+```sh
+# If not done previously, ensure the project is installed by poetry (only required once)
+poetry install
+# Use the `poetry run` command to ensure the installed project is used
+poetry run phylum-init -h
+```

README.md

@@ -1,7 +1,7 @@
 # phylum-ci
-[![PyPI](https://img.shields.io/pypi/v/phylum-ci)](https://pypi.org/project/phylum-ci/)
-![PyPI - Status](https://img.shields.io/pypi/status/phylum-ci)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/phylum-ci)](https://pypi.org/project/phylum-ci/)
+[![PyPI](https://img.shields.io/pypi/v/phylum)](https://pypi.org/project/phylum/)
+![PyPI - Status](https://img.shields.io/pypi/status/phylum)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/phylum)](https://pypi.org/project/phylum/)
 [![GitHub](https://img.shields.io/github/license/phylum-dev/phylum-ci)](https://github.com/phylum-dev/phylum-ci/blob/main/LICENSE)
 [![GitHub issues](https://img.shields.io/github/issues/phylum-dev/phylum-ci)](https://github.com/phylum-dev/phylum-ci/issues)
 ![GitHub last commit](https://img.shields.io/github/last-commit/phylum-dev/phylum-ci)
@@ -13,32 +13,50 @@ Python package for handling CI and other integrations
 
 ### Installation
 
-The `phylum-ci` package is pip installable for the environment of your choice:
+The `phylum` Python package is pip installable for the environment of your choice:
 
 ```sh
-pip install phylum-ci
+pip install phylum
 ```
 
 It can also also be installed in an isolated environment with the excellent [`pipx` tool](https://pypa.github.io/pipx/):
 
 ```sh
 # Globally install the app(s) on your system in an isolated virtual environment for the package
-pipx install phylum-ci
+pipx install phylum
 # Use the apps from the package in an ephemeral environment
-pipx run phylum-ci <options>
+pipx run --spec phylum phylum-init <options>
 ```
 
 It requires Python 3.7+ to run.
 
 ### Usage
-<!-- TODO: Fill this section in as functionality is added -->
-The `phylum-ci` package exposes its functionality with a command line interface (CLI). To view the options available
-from the CLI, print the help message:
+
+The `phylum` Python package exposes its functionality with a command line interface (CLI).
+To view the options available from the CLI, print the help message from one of the scripts provided as entry points:
 
 ```sh
-phylum-ci -h
+phylum-init -h
 ```
 
+The functionality can also be accessed by calling the module:
+
+```sh
+python -m phylum.init -h
+# The top level package is redirected to the phylum.init package:
+python -m phylum -h
+```
+
+#### `phylum-init`
+
+The `phylum-init` script can be used to fetch and install the Phylum CLI.
+It will attempt to install the latest released version of the CLI but can be specified to fetch a specific version.
+It will attempt to automatically determine the correct CLI release, based on the platform where the script is run, but
+a specific release target can be specified.
+It will accept a Phylum token from an environment variable or specified as an option, but will also function in the case
+that no token is provided. This can be because there is already a token set that should continue to be used or because
+no token exists and one will need to be manually created or set, after the CLI is installed.
+
 ## License
 
 MIT - with complete text available in the [LICENSE](LICENSE) file.

docs/release_process.md

@@ -65,7 +65,7 @@ approach, an option is exposed to optionally publish the built package to the
 environment. For example using `pipx` to run a specific developmental release version:
 
 ```sh
-pipx run --index-url https://test.pypi.org/simple/ --spec "phylum-ci==0.0.2.dev6" phylum-ci -h
+pipx run --index-url https://test.pypi.org/simple/ --spec "phylum==0.0.2.dev6" phylum-init -h
 ```
 
 Currently this workflow uses the `Staging` environment, as configured in