For documenting hardware projects with minimal effort,so you can stop writing and GitBuilding.
What is GitBuilding
GitBuilding is a program for documenting hardware. The goal of GitBuilding is to give you the freedom to write instructions in the form and structure that you want using markdown. Some extra syntax is added to generate the difficult things like bills of materials.
In GitBuilding you are able to:
- Write the instructions as you go along in markdown
- Tag links in the code with meta-data to show if they are steps in the build or parts that are needed
- Define a library including the part numbers for multiple suppliers
- Syntax for adding in bill of materials
Note: While we work out the best syntax, major things might change! If you have syntax suggestions please raise an issue!
To find out more visit our website.
How to install/use GitBuilding
To install (for Python 3.6+)
pip install gitbuilding
Installing the Dev package
We sporadically we build dev packages for testing. We don't recommend this for normal use and cannot promise features in it work. But it can be useful for testing.
Dev packages are stored on our internal package registry. To install them you will need a GitLab account and to make an access token.
To make the token:
- Log in to GitLab and go to your settings
- Select "Access Tokens" on the left menu
- Create a "Personal Access Token" with "real_api" scope
- Save this token for later
To install the dev package:
Download the wheel with:
pip download gitbuilding --no-deps --index-url https://__token__:<YOUR-TOKEN>@gitlab.com/api/v4/projects/9353371/packages/pypi/simple
<YOUR-TOKEN> with your personal access token.
Then install with:
pip install gitbuilding*.whl
Installing from source
Syntax for documentation
The syntax for documentation is in a format we call BuildUp. More details are available on the website.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size gitbuilding-0.7.0-py3-none-any.whl (1.0 MB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size gitbuilding-0.7.0.tar.gz (952.4 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for gitbuilding-0.7.0-py3-none-any.whl