# cherno
[](https://github.com/psf/black)
[](https://sdss-cherno.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/sdss/cherno/actions)
<!-- [](https://codecov.io/gh/sdss/cherno) -->
SDSS guider actor
## Installation
In general you should be able to install ``cherno`` by doing
```console
pip install sdss-cherno
```
To build from source, use
```console
git clone git@github.com:sdss/cherno
cd cherno
pip install .
```
## Development
`cherno` uses [poetry](http://poetry.eustace.io/) for dependency management and packaging. To work with an editable install it's recommended that you setup `poetry` and install `cherno` in a virtual environment by doing
```console
poetry install
```
### Style and type checking
This project uses the [black](https://github.com/psf/black) code style with 88-character line lengths for code and docstrings. It is recommended that you run `black` on save. Imports must be sorted using [isort](https://pycqa.github.io/isort/). The GitHub test workflow checks all the Python file to make sure they comply with the black formatting.
Configuration files for [flake8](https://flake8.pycqa.org/en/latest/), [isort](https://pycqa.github.io/isort/), and [black](https://github.com/psf/black) are provided and will be applied by most editors. For Visual Studio Code, the following project file is compatible with the project configuration:
```json
{
"python.formatting.provider": "black",
"[python]" : {
"editor.codeActionsOnSave": {
"source.organizeImports": true
},
"editor.formatOnSave": true
},
"[markdown]": {
"editor.wordWrapColumn": 88
},
"[restructuredtext]": {
"editor.wordWrapColumn": 88
},
"editor.rulers": [88],
"editor.wordWrapColumn": 88,
"python.analysis.typeCheckingMode": "basic"
}
```
This assumes that the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) extensions are installed.
This project uses [type hints](https://docs.python.org/3/library/typing.html). Typing is enforced by the test workflow using [pyright](https://github.com/microsoft/pyright) (in practice this means that if ``Pylance`` doesn't produce any errors in basic mode, ``pyright`` shouldn't).
Raw data
{
"_id": null,
"home_page": "https://github.com/sdss/cherno",
"name": "sdss-cherno",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "astronomy, software",
"author": "Jos\u00e9 S\u00e1nchez-Gallego",
"author_email": "gallegoj@uw.edu",
"download_url": "https://files.pythonhosted.org/packages/88/95/dadf5487e7516acf5b3baae5ff07a896b98a00d781d7bbdd40f82b3730b5/sdss_cherno-1.0.0.tar.gz",
"platform": null,
"description": "# cherno\n\n\n[](https://github.com/psf/black)\n[](https://sdss-cherno.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/sdss/cherno/actions)\n<!-- [](https://codecov.io/gh/sdss/cherno) -->\n\n\nSDSS guider actor\n\n## Installation\n\nIn general you should be able to install ``cherno`` by doing\n\n```console\npip install sdss-cherno\n```\n\nTo build from source, use\n\n```console\ngit clone git@github.com:sdss/cherno\ncd cherno\npip install .\n```\n\n## Development\n\n`cherno` uses [poetry](http://poetry.eustace.io/) for dependency management and packaging. To work with an editable install it's recommended that you setup `poetry` and install `cherno` in a virtual environment by doing\n\n```console\npoetry install\n```\n\n### Style and type checking\n\nThis project uses the [black](https://github.com/psf/black) code style with 88-character line lengths for code and docstrings. It is recommended that you run `black` on save. Imports must be sorted using [isort](https://pycqa.github.io/isort/). The GitHub test workflow checks all the Python file to make sure they comply with the black formatting.\n\nConfiguration files for [flake8](https://flake8.pycqa.org/en/latest/), [isort](https://pycqa.github.io/isort/), and [black](https://github.com/psf/black) are provided and will be applied by most editors. For Visual Studio Code, the following project file is compatible with the project configuration:\n\n```json\n{\n \"python.formatting.provider\": \"black\",\n \"[python]\" : {\n \"editor.codeActionsOnSave\": {\n \"source.organizeImports\": true\n },\n \"editor.formatOnSave\": true\n },\n \"[markdown]\": {\n \"editor.wordWrapColumn\": 88\n },\n \"[restructuredtext]\": {\n \"editor.wordWrapColumn\": 88\n },\n \"editor.rulers\": [88],\n \"editor.wordWrapColumn\": 88,\n \"python.analysis.typeCheckingMode\": \"basic\"\n}\n```\n\nThis assumes that the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) extensions are installed.\n\nThis project uses [type hints](https://docs.python.org/3/library/typing.html). Typing is enforced by the test workflow using [pyright](https://github.com/microsoft/pyright) (in practice this means that if ``Pylance`` doesn't produce any errors in basic mode, ``pyright`` shouldn't).\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "SDSS guider actor",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://sdss-cherno.readthedocs.org",
"Homepage": "https://github.com/sdss/cherno",
"Repository": "https://github.com/sdss/cherno"
},
"split_keywords": [
"astronomy",
" software"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f66e33a17d9ad4742ba01322de3854e281cd92912e63b5cd99a22733297adf68",
"md5": "2f1de53f13cc4977cd135e182f16e2a0",
"sha256": "b259c98fd46da1271d5de8ddf215dfb00cca21f12467b767edad08977921dcf9"
},
"downloads": -1,
"filename": "sdss_cherno-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2f1de53f13cc4977cd135e182f16e2a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 53441,
"upload_time": "2024-05-31T00:42:15",
"upload_time_iso_8601": "2024-05-31T00:42:15.389048Z",
"url": "https://files.pythonhosted.org/packages/f6/6e/33a17d9ad4742ba01322de3854e281cd92912e63b5cd99a22733297adf68/sdss_cherno-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8895dadf5487e7516acf5b3baae5ff07a896b98a00d781d7bbdd40f82b3730b5",
"md5": "aa6f93d562852a8db4e29b4b37d1dd2d",
"sha256": "e0530273138faf4a96ee2fb57e65e24467465760f038812071ddeb5a5712c198"
},
"downloads": -1,
"filename": "sdss_cherno-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "aa6f93d562852a8db4e29b4b37d1dd2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 41976,
"upload_time": "2024-05-31T00:42:17",
"upload_time_iso_8601": "2024-05-31T00:42:17.335398Z",
"url": "https://files.pythonhosted.org/packages/88/95/dadf5487e7516acf5b3baae5ff07a896b98a00d781d7bbdd40f82b3730b5/sdss_cherno-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-31 00:42:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sdss",
"github_project": "cherno",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sdss-cherno"
}
JSON
