COMPAS Event Extensions: adds event-based communication infrastructure to the COMPAS framework.
Project description
compas_eve
COMPAS Event Extensions: adds event-based communication infrastructure to the COMPAS framework.
Getting started with this project
Setup code editor
- Open project folder in VS Code
- Select python environment for the project
- First time using VS Code and on Windows? Make sure select the correct terminal profile:
Ctrl+Shift+P
,Terminal: Select Default Profile
and selectCommand Prompt
.
All terminal commands in the following sections can be run from the VS Code integrated terminal.
First steps with git
- Go to the
Source control
tab - Make an initial commit with all newly created files
First steps with code
-
Install the newly created project
pip install -e .
-
Install it on Rhino
python -m compas_rhino.install
Code conventions
Code convention follows PEP8 style guidelines and line length of 120 characters.
-
Check adherence to style guidelines
invoke lint
-
Format code automatically
invoke format
Documentation
Documentation is generated automatically out of docstrings and RST files in this repository
-
Generate the docs
invoke docs
-
Check links in docs are valid
invoke linkcheck
-
Open docs in your browser (file explorer ->
dist/docs/index.html
)
Testing
Tests are written using the pytest framework
-
Run all tests from terminal
invoke test
-
Or run them from VS Code from the
Testing
tab
Developing Grasshopper components
We use Grasshopper Componentizer to develop Python components that can be stored and edited on git.
-
Build components
invoke build-ghuser-components
-
Install components on Rhino
python -m compas_rhino.install
Publish release
Releases follow the semver versioning convention.
-
Create a new release
invoke release major
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for compas_eve-0.3.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 103b3234402822d90d5555d87211ea833df14380d13dd0f7281c9b8c90377aed |
|
MD5 | eef628244531f2b8917726804aa13082 |
|
BLAKE2b-256 | 58cf81cc555ac6ae34d4b5cb09eb2027c0ca067c176702176061134faf95a589 |