Iain Sproat
0ec404bbec
* Initial commit * Create CODE_OF_CONDUCT.md * Create CONTRIBUTING.MD * Update CODE_OF_CONDUCT.md adds authoritative source notice to this repo * Create ISSUE_TEMPLATE.md * Update CODE_OF_CONDUCT.md * Update and rename CONTRIBUTING.MD to CONTRIBUTING.md * Update README.md adds basic default social badges - discourse and twitter * Update README.md * Update README.md * Update README.md * Update README.md * Create LICENSE * Update README.md * Update README.md * Update CONTRIBUTING.md fixes link * Update CODE_OF_CONDUCT.md * docs: add slack link and badge * Update README.md * fix: link and typos * fix: more links * refactor: moved files to .github/ folder * feat: added PR template Updated docs to reflect it. * fix: updated old link * fix: added yaml frontmatter block to issue template * docs: removes links to slack * docs: adds link to docs * Update README.md * Create open-issue.yml * Create close-issue.yml * Fixes: PR template updated to provide detailed instructions * Add link to speckle-server contribution guide * Fix link to relative to the repo pull requests * Feature: separates issue template into bugs and feature requests * Provides checklist for both issue templates * Hides instructions in comments * Add link to contribution guidelines * Retain some sections from previous issue template * checklist is clearer * style: tidy newlines and other small formatting * Add a SECURITY.md file * Refer to the code of conduct in the contributing section of the README * chore(pr_template): adds a reference section to the PR template The SpecklePY PR template had a reference section, and it made sense to include it for all repositories. * Remove redundant issue template * fix(pull request template): pR template should be the default and not an option PR template was in a directory which allows selection using queries. The PR template should be provided by default so should be renamed and placed in the .github directory. Co-authored-by: Dimitrie Stefanescu <didimitrie@gmail.com> Co-authored-by: izzy lyseggen <izzy.lyseggen@gmail.com> Co-authored-by: Matteo Cominetti <matteo@cominetti.org> Co-authored-by: Alan Rynne <alan@speckle.systems> Co-authored-by: Alan Rynne <alan@rynne.es> Co-authored-by: Matteo Cominetti <matteo@speckle.systems>
Speckle | specklepy 🐍
The Python SDK
Speckle is the data infrastructure for the AEC industry.
About Speckle
What is Speckle? Check our
Features
- Object-based: say goodbye to files! Speckle is the first object based platform for the AEC industry
- Version control: Speckle is the Git & Hub for geometry and BIM data
- Collaboration: share your designs collaborate with others
- 3D Viewer: see your CAD and BIM models online, share and embed them anywhere
- Interoperability: get your CAD and BIM models into other software without exporting or importing
- Real time: get real time updates and notifications and changes
- GraphQL API: get what you need anywhere you want it
- Webhooks: the base for a automation and next-gen pipelines
- Built for developers: we are building Speckle with developers in mind and got tools for every stack
- Built for the AEC industry: Speckle connectors are plugins for the most common software used in the industry such as Revit, Rhino, Grasshopper, AutoCAD, Civil 3D, Excel, Unreal Engine, Unity, QGIS, Blender and more!
Try Speckle now!
Give Speckle a try in no time by:
⇒ creating an account at our public server
⇒ deploying an instance in 1 click
Resources
for help, feature requests or just to hang with other speckle enthusiasts, check out our community forum!
our tutorials portal is full of resources to get you started using Speckle
reference on almost any end-user and developer functionality
Repo structure
Usage
Send and receive data from a Speckle Server with operations, interact with the Speckle API with the SpeckleClient, create and extend your own custom Speckle Objects with Base, and more!
Head to the 📚 specklepy docs for more information and usage examples.
Developing & Debugging
Installation
This project uses python-poetry for dependency management, make sure you follow the official docs to get poetry.
To bootstrap the project environment run $ poetry install. This will create a new virtual-env for the project and install both the package and dev dependencies.
If this is your first time using poetry and you're used to creating your venvs within the project directory, run poetry config virtualenvs.in-project true to configure poetry to do the same.
To execute any python script run $ poetry run python my_script.py
Alternatively you may roll your own virtual-env with either venv, virtualenv, pyenv-virtualenv etc. Poetry will play along an recognize if it is invoked from inside a virtual environment.
Local Data Paths
It may be helpful to know where the local accounts and object cache dbs are stored. Depending on on your OS, you can find the dbs at:
- Windows:
APPDATAor<USER>\AppData\Roaming\Speckle - Linux:
$XDG_DATA_HOMEor by default~/.local/share/Speckle - Mac:
~/.config/Speckle
Contributing
Please make sure you read the contribution guidelines and code of conduct for an overview of the practices we try to follow.
Community
The Speckle Community hangs out on the forum, do join and introduce yourself & feel free to ask us questions!
Security
For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.
License
Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via email.