Björn Steinhagen
40 lines
2.7 KiB
Markdown
40 lines
2.7 KiB
Markdown
# bg_specklepy
|
|
Bollinger+Grohmann Library with [specklepy](https://github.com/specklesystems/specklepy).
|
|
|
|
## 📚 Description
|
|
Python library aimed at extending the functionality of [specklepy](https://github.com/specklesystems/specklepy).
|
|
|
|
## 🖇 Dependencies
|
|
Required dependencies are automatically checked. Should a library not be available for a specific class / method, the user will be prompted to install with a simple "y" input on the console.
|
|
* <img align="left" alt="specklepy" width="90px" src="https://speckle.systems/content/images/2022/06/logo-blue-2.png" style="padding-right:5px;">
|
|
* 
|
|
* 
|
|
* <img align="left" alt="specklepy" width="26px" src="https://user-images.githubusercontent.com/1403074/50364429-c135c980-0524-11e9-8128-bdefe1ea8de8.png" style="padding-right:5px;">trimesh
|
|
|
|
## ⚖ License
|
|
[](https://www.gnu.org/licenses/gpl-3.0), details [here](https://github.com/BollingerGrohmann/SPKL-BG-SpecklePY-LIB/blob/main/LICENSE)
|
|
|
|
## 🙌 Special Thanks To
|
|
A special word of appreciation goes out to the [Speckle Team](https://speckle.systems/). Continuous support throughout development, for example, in the [Community platform](https://speckle.community/) by [@jsdbroughton](https://github.com/jsdbroughton) made a profound impact on development.
|
|
|
|
## 💭 Examples
|
|
[01 - Column Eccentricity Example](https://github.com/BollingerGrohmann/SPKL-BG-SpecklePY-LIB/wiki/01-Column-Eccentricity-Example)
|
|
|
|
## 🚀 Contributions
|
|
Any and all contributions are welcome! Kindly follow the below guidelines:
|
|
1. Clone the repository
|
|
- *This will create a copy of the project on your computer that you can modify and test*
|
|
2. Create a new branch **before** you start making changes
|
|
- *Naming convention: **yourUsername-FeatureAddedOrChange***
|
|
- *This will allow you to work on a separate copy of the project without affecting the original code*
|
|
3. Make changes / developments / advancements
|
|
- *Test your changes before submitting them, ideally with a unit test / example script*
|
|
4. Commit your changes once you are done
|
|
5. Push changes to GitHub
|
|
6. Create a **pull request**
|
|
- *Pull request should include a description of the changes you made and why they are important*
|
|
7. Respond to feedback from reviewer(s)
|
|
|
|
## 🤝 Collaborations
|
|
Keen to collaborate? So are we! Feel free to reach out under the [Discussions Tab](https://github.com/BollingerGrohmann/SPKL-BG-SpecklePY-LIB/discussions) or on [LinkedIn](https://www.linkedin.com/company/bollingergrohmann).
|