diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 87546333..e25b6bea 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -52,4 +52,4 @@ "postCreateCommand": "poetry config virtualenvs.create false && poetry install", // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. "remoteUser": "vscode" -} \ No newline at end of file +} diff --git a/.devcontainer/docker-compose.yaml b/.devcontainer/docker-compose.yaml index 46b94dc4..6bfc1478 100644 --- a/.devcontainer/docker-compose.yaml +++ b/.devcontainer/docker-compose.yaml @@ -41,4 +41,4 @@ services: command: /bin/sh -c "while sleep 1000; do :; done" network_mode: host # networks: -# default: \ No newline at end of file +# default: diff --git a/.gitattributes b/.gitattributes index 5dc46e6b..314766e9 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,3 @@ * text=auto eol=lf *.{cmd,[cC][mM][dD]} text eol=crlf -*.{bat,[bB][aA][tT]} text eol=crlf \ No newline at end of file +*.{bat,[bB][aA][tT]} text eol=crlf diff --git a/.gitignore b/.gitignore index b893e583..80226df1 100644 --- a/.gitignore +++ b/.gitignore @@ -112,4 +112,4 @@ venv.bak/ # other scratch.py -settings.json \ No newline at end of file +settings.json diff --git a/.vscode/launch.json b/.vscode/launch.json index ccfbf0c5..1a8aba5d 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -4,7 +4,7 @@ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ - + { "name": "Python: Current File", "type": "python", @@ -23,4 +23,4 @@ "justMyCode": true } ] -} \ No newline at end of file +} diff --git a/README.md b/README.md index c7da9d83..de9743d6 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ What is Speckle? Check our ![YouTube Video Views](https://img.shields.io/youtube Give Speckle a try in no time by: - [![speckle XYZ](https://img.shields.io/badge/https://-speckle.xyz-0069ff?style=flat-square&logo=hackthebox&logoColor=white)](https://speckle.xyz) ⇒ creating an account at our public server -- [![create a droplet](https://img.shields.io/badge/Create%20a%20Droplet-0069ff?style=flat-square&logo=digitalocean&logoColor=white)](https://marketplace.digitalocean.com/apps/speckle-server?refcode=947a2b5d7dc1) ⇒ deploying an instance in 1 click +- [![create a droplet](https://img.shields.io/badge/Create%20a%20Droplet-0069ff?style=flat-square&logo=digitalocean&logoColor=white)](https://marketplace.digitalocean.com/apps/speckle-server?refcode=947a2b5d7dc1) ⇒ deploying an instance in 1 click ### Resources @@ -47,7 +47,7 @@ Give Speckle a try in no time by: ## 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! +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**](https://speckle.guide/dev/python.html) for more information and usage examples. @@ -65,6 +65,12 @@ 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. +### Style guide + +All our repo wide styling linting and other rules are checked and enforced by `pre-commit`, which is included in the dev dependencies. +It is recommended to set up `pre-commit` after installing the dependencies by running `$ pre-commit install`. +Commiting code that doesn't adhere to the given rules, will fail the checks in our CI system. + ### 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: @@ -82,7 +88,7 @@ The Speckle Community hangs out on [the forum](https://discourse.speckle.works), ## Security -For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems. +For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems. ## License diff --git a/pyproject.toml b/pyproject.toml index 5c01e55a..9dcdb08d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -62,4 +62,4 @@ requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" [tool.isort] -profile = "black" \ No newline at end of file +profile = "black" diff --git a/src/specklepy/api/resources/branch.py b/src/specklepy/api/resources/branch.py index 5e8aa10c..7f3f2280 100644 --- a/src/specklepy/api/resources/branch.py +++ b/src/specklepy/api/resources/branch.py @@ -87,7 +87,7 @@ def get(self, stream_id: str, name: str, commits_limit: int = 10): createdAt } } - } + } } } """