Skip to content

🔧 add .python-version file and update README with Python version requirement for building docs #695

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

🔧 add .python-version file and update README with Python version requirement for building docs #695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9f4d5df
🔧 add .python-version file and update README with Python version requ…
azigler Apr 21, 2025
9e18ecd
Merge branch 'main' into add-docs-python-version
azigler Apr 21, 2025
0be6ee7
Merge branch 'main' into add-docs-python-version
azigler Apr 28, 2025
34a71e5
Merge branch 'main' into add-docs-python-version
vim-zz May 7, 2025
909a987
Merge branch 'main' into add-docs-python-version
azigler May 8, 2025
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
1 change: 1 addition & 0 deletions .python-version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.10
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@
<a href="https://github.com/linear-b/gitstream/discussions/102">Feature Updates</a>
</p>


## ⭐️ Why gitStream?

Our research shows that code reviews are [the most consistent bottleneck in the software development process](https://devinterrupted.substack.com/p/analysis-the-quickest-path-to-halving?utm_source=G&utm_medium=referral&utm_campaign=gitStream+-+GitHub+Repo), so we built gitStream to enable dev teams to use simple YAML configurations to reduce code review toil and improve software quality.

## ✨ Features
Expand All @@ -62,14 +62,13 @@ gitStream is a GitHub / GitLab / Bitbucket app that processes automations define

If you're ready to install gitStream, or want to explore its automation capabilities, [head over to the docs](https://docs.gitstream.cm). You can have your first automation up and running in as little as 2 minutes.


## 📣 Updates

Subscribe to [gitStream Feature Announcements](https://github.com/linear-b/gitstream/discussions/102).

## 📁 Local Documentation Server Setup

To run the documentation server locally using Python3, follow these steps:
To run the documentation server locally using Python (<=3.10, see `.python-version`), follow these steps:

1. Create a virtual environment named `.venv` using the command `python -m venv .venv`
2. Activate the virtual environment by running the command `. ./.venv/bin/activate`
Expand All @@ -78,8 +77,8 @@ To run the documentation server locally using Python3, follow these steps:

The local documentation server should now be running at `http://127.0.0.1:8000/`.


# LinearB

gitStream is a free product from the team at [LinearB](https://linearb.io/?utm_source=Gi&utm_medium=referral&utm_campaign=gitStream+-+GitHub+Repo): the industry-leading platform for software delivery management that has helped thousands of developers around the world improve their team's productivity.

<div align="center">
Expand Down