Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document possibility of installing ssg module with pip #12658

Merged
merged 3 commits into from
Dec 3, 2024
Merged

Document possibility of installing ssg module with pip #12658

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
facdf44
document possibility of installing ssg module with pip
vojtapolasek Dec 2, 2024
1d7801c
Apply suggestions from code review
vojtapolasek Dec 2, 2024
5320697
add missing new lines
vojtapolasek Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/manual/developer/05_tools_and_utilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,29 @@ 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`.
In this case it is recommended to install it within a Python virtual environment.
Please note that this possibility was added after releasing the 0.1.75 version and until the release 0.1.76 is out it can only be installed from `master` branch.
To install the ssg module currently present in the master branch, run the following command:

```bash
pip install git+https://github.com/ComplianceasCode/content
```

It is also possible to install an ssg library version associated with a certain release.
marcusburghardt marked this conversation as resolved.
Show resolved Hide resolved
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 this way, please pay close attention to the 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
Loading