# aind-smartsheet-api
[](LICENSE)
[](https://github.com/semantic-release/semantic-release)
Small wrapper around smartsheet-python-sdk to help parsing into pydantic models
## Basic Usage Example
```python
from aind_smartsheet_api.client import SmartsheetClient, SmartsheetSettings
settings = SmartsheetSettings(access_token="*****")
client = SmartsheetClient(smartsheet_settings=settings)
# get a basic response
basic_response = client.get_parsed_sheet(sheet_id="<int value of sheet id requesting>")
```
Parsing into pydantic model
```python
from aind_smartsheet_api.client import SmartsheetClient, SmartsheetSettings
from pydantic import BaseModel, Field, ConfigDict
from typing import Optional
class MyModel(BaseModel):
project_name: Optional[str] = Field(None, alias="Project Name")
project_code: str = Field(..., alias="Project Code")
funding_institution: str = Field(..., alias="Funding Institution")
grant_number: Optional[str] = Field(None, alias="Grant Number")
investigators: str = Field(..., alias="Investigators")
model_config = ConfigDict(populate_by_name=True)
settings = SmartsheetSettings(access_token="*****")
client = SmartsheetClient(smartsheet_settings=settings)
# get a response parsed into MyModel
model_response = client.get_parsed_sheet_model(
sheet_id="<int value of sheet id requesting>", model=MyModel
)
```
## Installation
To use the software, in the root directory, run
```bash
pip install -e .
```
To develop the code, run
```bash
pip install -e .[dev]
```
## Contributing
### Linters and testing
There are several libraries used to run linters, check documentation, and run tests.
- Please test your changes using the **coverage** library, which will run the tests and log a coverage report:
```bash
coverage run -m unittest discover && coverage report
```
- Use **interrogate** to check that modules, methods, etc. have been documented thoroughly:
```bash
interrogate .
```
- Use **flake8** to check that code is up to standards (no unused imports, etc.):
```bash
flake8 .
```
- Use **black** to automatically format the code into PEP standards:
```bash
black .
```
- Use **isort** to automatically sort import statements:
```bash
isort .
```
### Pull requests
For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) style for commit messages. Roughly, they should follow the pattern:
```text
<type>(<scope>): <short summary>
```
where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
- **build**: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
- **ci**: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
- **docs**: Documentation only changes
- **feat**: A new feature
- **fix**: A bugfix
- **perf**: A code change that improves performance
- **refactor**: A code change that neither fixes a bug nor adds a feature
- **test**: Adding missing tests or correcting existing tests
### Semantic Release
The table below, from [semantic release](https://github.com/semantic-release/semantic-release), shows which commit message gets you which release type when `semantic-release` runs (using the default configuration):
| Commit message | Release type |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
| `fix(pencil): stop graphite breaking when too much pressure applied` | ~~Patch~~ Fix Release, Default release |
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |
### Documentation
To generate the rst files source files for documentation, run
```bash
sphinx-apidoc -o doc_template/source/ src
```
Then to create the documentation HTML files, run
```bash
sphinx-build -b html doc_template/source/ doc_template/build/html
```
More info on sphinx installation can be found [here](https://www.sphinx-doc.org/en/master/usage/installation.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "aind-smartsheet-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Allen Institute for Neural Dynamics",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b4/8d/399f7268f3d699599f5e6864166b16399a41377e797526ebfca08a9fec05/aind_smartsheet_api-0.1.1.tar.gz",
"platform": null,
"description": "# aind-smartsheet-api\n\n[](LICENSE)\n\n[](https://github.com/semantic-release/semantic-release)\n\n\n\n\nSmall wrapper around smartsheet-python-sdk to help parsing into pydantic models\n\n## Basic Usage Example\n```python\nfrom aind_smartsheet_api.client import SmartsheetClient, SmartsheetSettings\nsettings = SmartsheetSettings(access_token=\"*****\")\nclient = SmartsheetClient(smartsheet_settings=settings)\n# get a basic response\nbasic_response = client.get_parsed_sheet(sheet_id=\"<int value of sheet id requesting>\")\n```\n\nParsing into pydantic model\n```python\nfrom aind_smartsheet_api.client import SmartsheetClient, SmartsheetSettings\nfrom pydantic import BaseModel, Field, ConfigDict\nfrom typing import Optional\n\nclass MyModel(BaseModel):\n project_name: Optional[str] = Field(None, alias=\"Project Name\")\n project_code: str = Field(..., alias=\"Project Code\")\n funding_institution: str = Field(..., alias=\"Funding Institution\")\n grant_number: Optional[str] = Field(None, alias=\"Grant Number\")\n investigators: str = Field(..., alias=\"Investigators\")\n model_config = ConfigDict(populate_by_name=True)\n\nsettings = SmartsheetSettings(access_token=\"*****\")\nclient = SmartsheetClient(smartsheet_settings=settings)\n# get a response parsed into MyModel\nmodel_response = client.get_parsed_sheet_model(\n sheet_id=\"<int value of sheet id requesting>\", model=MyModel\n)\n```\n\n\n## Installation\nTo use the software, in the root directory, run\n```bash\npip install -e .\n```\n\nTo develop the code, run\n```bash\npip install -e .[dev]\n```\n\n## Contributing\n\n### Linters and testing\n\nThere are several libraries used to run linters, check documentation, and run tests.\n\n- Please test your changes using the **coverage** library, which will run the tests and log a coverage report:\n\n```bash\ncoverage run -m unittest discover && coverage report\n```\n\n- Use **interrogate** to check that modules, methods, etc. have been documented thoroughly:\n\n```bash\ninterrogate .\n```\n\n- Use **flake8** to check that code is up to standards (no unused imports, etc.):\n```bash\nflake8 .\n```\n\n- Use **black** to automatically format the code into PEP standards:\n```bash\nblack .\n```\n\n- Use **isort** to automatically sort import statements:\n```bash\nisort .\n```\n\n### Pull requests\n\nFor internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) style for commit messages. Roughly, they should follow the pattern:\n```text\n<type>(<scope>): <short summary>\n```\n\nwhere scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:\n\n- **build**: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)\n- **ci**: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)\n- **docs**: Documentation only changes\n- **feat**: A new feature\n- **fix**: A bugfix\n- **perf**: A code change that improves performance\n- **refactor**: A code change that neither fixes a bug nor adds a feature\n- **test**: Adding missing tests or correcting existing tests\n\n### Semantic Release\n\nThe table below, from [semantic release](https://github.com/semantic-release/semantic-release), shows which commit message gets you which release type when `semantic-release` runs (using the default configuration):\n\n| Commit message | Release type |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |\n| `fix(pencil): stop graphite breaking when too much pressure applied` | ~~Patch~~ Fix Release, Default release |\n| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |\n| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |\n\n### Documentation\nTo generate the rst files source files for documentation, run\n```bash\nsphinx-apidoc -o doc_template/source/ src \n```\nThen to create the documentation HTML files, run\n```bash\nsphinx-build -b html doc_template/source/ doc_template/build/html\n```\nMore info on sphinx installation can be found [here](https://www.sphinx-doc.org/en/master/usage/installation.html).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Generated from aind-library-template",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "857cb9062f2a727ae49c051475846b5edf058c9ca8d3a481e73796beb8cb3136",
"md5": "0ab85c7b7606e79248c62ccc0ccb3256",
"sha256": "cdc3f20033c5bbf479cfc792acafb3344fc775584836251b15dc7f771644d14c"
},
"downloads": -1,
"filename": "aind_smartsheet_api-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ab85c7b7606e79248c62ccc0ccb3256",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7139,
"upload_time": "2024-09-18T22:16:10",
"upload_time_iso_8601": "2024-09-18T22:16:10.675881Z",
"url": "https://files.pythonhosted.org/packages/85/7c/b9062f2a727ae49c051475846b5edf058c9ca8d3a481e73796beb8cb3136/aind_smartsheet_api-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b48d399f7268f3d699599f5e6864166b16399a41377e797526ebfca08a9fec05",
"md5": "9d261aa1ab29f8d2afca4ebff1c89eeb",
"sha256": "0d2a9c0fe06876197f9df74dd041a2ab9396ab56bd53a34e6e1a44aad92a68b6"
},
"downloads": -1,
"filename": "aind_smartsheet_api-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "9d261aa1ab29f8d2afca4ebff1c89eeb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 39820,
"upload_time": "2024-09-18T22:16:11",
"upload_time_iso_8601": "2024-09-18T22:16:11.827451Z",
"url": "https://files.pythonhosted.org/packages/b4/8d/399f7268f3d699599f5e6864166b16399a41377e797526ebfca08a9fec05/aind_smartsheet_api-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 22:16:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aind-smartsheet-api"
}
JSON