Skip to content

Commit

Permalink
document possibility of installing ssg module with pip
Browse files Browse the repository at this point in the history
  • Loading branch information
vojtapolasek committed Dec 2, 2024
1 parent 66a905a commit facdf44
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/manual/developer/05_tools_and_utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,27 @@ this easier: `.pyenv.sh`. To set `PYTHONPATH` correctly for the current
shell, simply call `source .pyenv.sh`. For more information on how to
use this script, please see the comments at the top of the file.

It is also possible to install the module with pip.
Please note that this possibility was added after releasing the 0.1.75 version.
To install the ssg module s it is currently present in the master branch, run the following command (possibly within a Python virtual environment):
```bash
pip install git+https://github.com/ComplianceasCode/content
```

It is also possible to install an ssg library version associated with a certain release.
This is recommended because the library is not stable and it can change unexpectedly when installing from master.
This is an example command which installs the library associated with the 0.1.76 release:

```bash
pip install git+https://github.com/ComplianceasCode/[email protected]
```

The installed package is named `ssg`.
Please note that the name of the package will very probably change in the future.
Therefore, if you install the module in this way, please pay close attention to release notes.
It is worth emphasizing here that stability of the module is not guaranteed.
Currently, it is used mainly for building the content and it is therefore modified predominantly based on needs of the content build system.

## Profile Statistics and Utilities

The `profile_tool.py` tool displays XCCDF profile statistics. It can
Expand Down

0 comments on commit facdf44

Please sign in to comment.