# sdss_access
[](https://sdss-access.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/sdss/sdss_access/actions/workflows/sphinxbuild.yml)
[](https://github.com/sdss/sdss_access/actions/workflows/build.yml)
[](https://codecov.io/gh/sdss/sdss_access)
This products allows for dynamically building filepaths to SDSS data products hosted on the Science Archive Server (SAS). Filepaths
are dynamically constructed given a minimal name and set of keywords to be substituted via a string templating system. Data products
can also be downloaded programmatically using an ``Access`` class which provides streaming downloads via ``rysnc`` or ``curl``
depending on your OS. See the full documentation at http://sdss-access.readthedocs.io/en/latest/
## Developer Install
To install `sdss_access` for development locally:
```
git clone https://github.com/sdss/sdss_access
cd sdss_acccess
pip install -e ".[dev,docs]"
```
## Build Sphinx Docs
Within the top level repo directory, run the `sdsstools` commands:
```
# build the Sphinx documentation
sdss docs.build
# open the docs locally in a browser
sdss docs.show
```
Documentation is automatically built and pushed to Read The Docs.
## Testing
Tests are created using `pytest`. Navigate to the `tests` directory from the top level and run with `pytest`.
```
cd tests
pytest
```
## Creating Releases
New releases of `sdss-access` are created automatically, and pushed to [PyPi](https://pypi.org/project/sdss-access/), when new tags are pushed to Github. See the [Create Release](.github/workflows/release.yml) Github Action and [Releases](https://github.com/sdss/sdss_access/releases) for the list.
New tag names follow the Python semantic versioning syntax, i.e. `X.Y.Z`.
# Useful links
- GitHub: https://github.com/sdss/sdss_access
- Documentation: https://sdss-access.readthedocs.org
- Issues: https://github.com/sdss/sdss_access/issues
Raw data
{
"_id": null,
"home_page": "https://github.com/sdss/sdss_access",
"name": "sdss-access",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "astronomy,software",
"author": "Brian Cherinka",
"author_email": "bcherinka@stsci.edu",
"download_url": "https://files.pythonhosted.org/packages/10/4a/04e4d9f575b3cc0e2132dad3119c036c4118e04e8b2c54f99532b0d4d842/sdss-access-3.0.4.tar.gz",
"platform": null,
"description": "# sdss_access\n\n\n[](https://sdss-access.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/sdss/sdss_access/actions/workflows/sphinxbuild.yml)\n[](https://github.com/sdss/sdss_access/actions/workflows/build.yml)\n[](https://codecov.io/gh/sdss/sdss_access)\n\n\nThis products allows for dynamically building filepaths to SDSS data products hosted on the Science Archive Server (SAS). Filepaths\nare dynamically constructed given a minimal name and set of keywords to be substituted via a string templating system. Data products\ncan also be downloaded programmatically using an ``Access`` class which provides streaming downloads via ``rysnc`` or ``curl``\ndepending on your OS. See the full documentation at http://sdss-access.readthedocs.io/en/latest/\n\n## Developer Install\n\nTo install `sdss_access` for development locally:\n\n```\ngit clone https://github.com/sdss/sdss_access\ncd sdss_acccess\npip install -e \".[dev,docs]\"\n```\n\n## Build Sphinx Docs\n\nWithin the top level repo directory, run the `sdsstools` commands:\n```\n# build the Sphinx documentation\nsdss docs.build\n\n# open the docs locally in a browser\nsdss docs.show\n```\nDocumentation is automatically built and pushed to Read The Docs.\n\n## Testing\nTests are created using `pytest`. Navigate to the `tests` directory from the top level and run with `pytest`.\n```\ncd tests\npytest\n```\n\n## Creating Releases\n\nNew releases of `sdss-access` are created automatically, and pushed to [PyPi](https://pypi.org/project/sdss-access/), when new tags are pushed to Github. See the [Create Release](.github/workflows/release.yml) Github Action and [Releases](https://github.com/sdss/sdss_access/releases) for the list.\n\nNew tag names follow the Python semantic versioning syntax, i.e. `X.Y.Z`.\n\n# Useful links\n\n- GitHub: https://github.com/sdss/sdss_access\n- Documentation: https://sdss-access.readthedocs.org\n- Issues: https://github.com/sdss/sdss_access/issues\n\n\n\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Package to dynamically build filepaths and access all SDSS SAS products",
"version": "3.0.4",
"project_urls": {
"Documentation": "https://sdss-access.readthedocs.org",
"Homepage": "https://github.com/sdss/sdss_access",
"Repository": "https://github.com/sdss/sdss_access"
},
"split_keywords": [
"astronomy",
"software"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53888a8eca7382b9a03b8cc466b3741b5a1ef5925cf5ef7ec0ce2e0021009d1a",
"md5": "959a1d685c8500aab7e6c7eef999977a",
"sha256": "1025d5409ff61ddf82ed5973a8769c193279fb3f75be6b8d4d5495a2d161e124"
},
"downloads": -1,
"filename": "sdss_access-3.0.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "959a1d685c8500aab7e6c7eef999977a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 38740,
"upload_time": "2024-03-08T17:31:38",
"upload_time_iso_8601": "2024-03-08T17:31:38.937904Z",
"url": "https://files.pythonhosted.org/packages/53/88/8a8eca7382b9a03b8cc466b3741b5a1ef5925cf5ef7ec0ce2e0021009d1a/sdss_access-3.0.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "104a04e4d9f575b3cc0e2132dad3119c036c4118e04e8b2c54f99532b0d4d842",
"md5": "81dc6ac69c007f477d889a7864e4c33d",
"sha256": "2fbb45058e2254f5a7de557c2a65208a2460795360572d40b4aa47f9f76eb72b"
},
"downloads": -1,
"filename": "sdss-access-3.0.4.tar.gz",
"has_sig": false,
"md5_digest": "81dc6ac69c007f477d889a7864e4c33d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 32704,
"upload_time": "2024-03-08T17:31:40",
"upload_time_iso_8601": "2024-03-08T17:31:40.652858Z",
"url": "https://files.pythonhosted.org/packages/10/4a/04e4d9f575b3cc0e2132dad3119c036c4118e04e8b2c54f99532b0d4d842/sdss-access-3.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 17:31:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sdss",
"github_project": "sdss_access",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "sdss-access"
}
JSON
