# 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_access
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": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "astronomy, software",
"author": "Brian Cherinka",
"author_email": "bcherinka@stsci.edu",
"download_url": "https://files.pythonhosted.org/packages/be/0a/4b1ef60e2021f6278ff0dee66f30adc11b603cacf7c8838c1d88643e1da9/sdss-access-3.0.5.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_access\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.5",
"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": "a19cd5d3a9da9d717a6985c51a45755667e1c8df7f9895e78614ae95cd9471be",
"md5": "88eb1ed61850cb9831f19019e60ee315",
"sha256": "9273616e330ac15b9781308b992480f95326db9c75132ce9816323686ecc057a"
},
"downloads": -1,
"filename": "sdss_access-3.0.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "88eb1ed61850cb9831f19019e60ee315",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 39704,
"upload_time": "2024-12-04T18:25:26",
"upload_time_iso_8601": "2024-12-04T18:25:26.040311Z",
"url": "https://files.pythonhosted.org/packages/a1/9c/d5d3a9da9d717a6985c51a45755667e1c8df7f9895e78614ae95cd9471be/sdss_access-3.0.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be0a4b1ef60e2021f6278ff0dee66f30adc11b603cacf7c8838c1d88643e1da9",
"md5": "f8ce5b0d8cee21b1741ee259e5d36f93",
"sha256": "36faa984b18d0c76b3f55a3c6bb58b853cd1bc7e6953f07d99c8d7d88a34657d"
},
"downloads": -1,
"filename": "sdss-access-3.0.5.tar.gz",
"has_sig": false,
"md5_digest": "f8ce5b0d8cee21b1741ee259e5d36f93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 33857,
"upload_time": "2024-12-04T18:25:27",
"upload_time_iso_8601": "2024-12-04T18:25:27.438705Z",
"url": "https://files.pythonhosted.org/packages/be/0a/4b1ef60e2021f6278ff0dee66f30adc11b603cacf7c8838c1d88643e1da9/sdss-access-3.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 18:25:27",
"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
