{"id":19175999,"url":"https://github.com/astropy-learn/learn-astropy-librarian","last_synced_at":"2026-06-20T13:30:17.460Z","repository":{"id":37851404,"uuid":"230807501","full_name":"astropy/learn-astropy-librarian","owner":"astropy","description":"The content crawler that supplies Learn Astropy's web search.","archived":false,"fork":false,"pushed_at":"2024-10-28T12:53:54.000Z","size":628,"stargazers_count":1,"open_issues_count":7,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-10-29T16:02:41.913Z","etag":null,"topics":["learn-astropy"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/astropy.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.rst","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"numfocus","custom":"https://numfocus.org/donate-to-astropy"}},"created_at":"2019-12-29T21:52:35.000Z","updated_at":"2024-10-29T12:54:20.000Z","dependencies_parsed_at":"2024-11-06T17:33:05.852Z","dependency_job_id":null,"html_url":"https://github.com/astropy/learn-astropy-librarian","commit_stats":{"total_commits":161,"total_committers":7,"mean_commits":23.0,"dds":0.2360248447204969,"last_synced_commit":"6cf559fe5d83e1a5031721a5f878c0ad47c7fd06"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astropy%2Flearn-astropy-librarian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astropy%2Flearn-astropy-librarian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astropy%2Flearn-astropy-librarian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/astropy%2Flearn-astropy-librarian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/astropy","download_url":"https://codeload.github.com/astropy/learn-astropy-librarian/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238237310,"owners_count":19439041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["learn-astropy"],"created_at":"2024-11-09T10:26:48.547Z","updated_at":"2026-06-20T13:30:17.409Z","avatar_url":"https://github.com/astropy.png","language":"HTML","funding_links":["https://github.com/sponsors/numfocus","https://numfocus.org/donate-to-astropy"],"categories":[],"sub_categories":[],"readme":"#######################\nlearn-astropy-librarian\n#######################\n\nThe content crawler that supplies Learn Astropy's web search.\n\nCommand line interface\n======================\n\n::\n\n    Usage: astropylibrarian [OPTIONS] COMMAND [ARGS]...\n\n      Manage the content index for the Learn Astropy project.\n\n      Astropy Librarian helps you work with the Algolia index that powers the\n      content listing and search for Learn Astropy, https://learn.astropy.org.\n\n      Astropy Librarian is developed at https://github.com/astropy/learn-\n      astropy-librarian\n\n    Options:\n      -v, --verbose                   Verbose output. Use -v for info-type logging\n                                      and -vv for debug-level logging.  [default:\n                                      0]\n\n      --install-completion [bash|zsh|fish|powershell|pwsh]\n                                      Install completion for the specified shell.\n      --show-completion [bash|zsh|fish|powershell|pwsh]\n                                      Show completion for the specified shell, to\n                                      copy it or customize the installation.\n\n      --help                          Show this message and exit.\n\n    Commands:\n      delete  Delete Algolia records.\n      index   Content indexing commands.\n\nastropylibrarian index tutorial\n-------------------------------\n\n::\n\n    Usage: astropylibrarian index tutorial [OPTIONS] URL\n\n      Index a single tutorial.\n\n    Arguments:\n      URL  URL for a tutorial.  [required]\n\n    Options:\n      --algolia-id TEXT   Algolia app ID.  [env var: ALGOLIA_ID; required]\n      --algolia-key TEXT  Algolia API key.  [env var: ALGOLIA_KEY; required]\n      --index TEXT        Name of the Algolia index.  [env var: ALGOLIA_INDEX;\n                          required]\n\n      --priority INTEGER  Priority for default sorting (higher numbers appear\n                          first)  [default: 0]\n\n      --path PATH         Local path of tutorial HTML, if available.\n      --help              Show this message and exit.\n\nastropylibrarian index tutorial-site\n------------------------------------\n\n\n::\n\n  Usage: astropylibrarian index tutorial-site [OPTIONS] SITE_DIR URL\n\n    Index a directory of tutorial HTML files.\n\n    This command is useful for automated CI workflows. The site_dir argument\n    is the directory of tutorials built by nbcollection and url is the root\n    URL where these tutorials are published on the web. This command indexes\n    each HTML file as a tutorial, except for those with paths specified in the\n    --ignore argument. The root index.html file is always ignored.\n\n  Arguments:\n    SITE_DIR  Local path tutorial build directory  [required]\n    URL       Base URL for tutorials.  [required]\n\n  Options:\n    --algolia-id TEXT   Algolia app ID.  [env var: ALGOLIA_ID; required]\n    --algolia-key TEXT  Algolia API key.  [env var: ALGOLIA_KEY; required]\n    --index TEXT        Name of the Algolia index.  [env var: ALGOLIA_INDEX;\n                        required]\n\n    --ignore TEXT       List of HTML files to ignore from indexing. The root\n                        index.html file is always excluded.  [default:\n                        (dynamic)]\n\n    --help              Show this message and exit.\n\nastropylibrarian index guide\n----------------------------\n\n::\n\n    Usage: astropylibrarian index guide [OPTIONS] URL\n\n      Index a guide.\n\n    Arguments:\n      URL  Root URL for a guide.  [required]\n\n    Options:\n      --algolia-id TEXT   Algolia app ID.  [env var: ALGOLIA_ID; required]\n      --algolia-key TEXT  Algolia API key.  [env var: ALGOLIA_KEY; required]\n      --index TEXT        Name of the Algolia index.  [env var: ALGOLIA_INDEX;\n                          required]\n\n      --priority INTEGER  Priority for default sorting (higher numbers appear\n                          first)  [default: 0]\n\n      --help              Show this message and exit.\n\nastropylibrarian delete\n-----------------------\n\n::\n\n    Usage: astropylibrarian delete [OPTIONS] URL\n\n      Delete Algolia records.\n\n    Arguments:\n      URL  Root URL to delete  [required]\n\n    Options:\n      --algolia-id TEXT   Algolia app ID.  [env var: ALGOLIA_ID; required]\n      --algolia-key TEXT  Algolia API key.  [env var: ALGOLIA_KEY; required]\n      --index TEXT        Name of the Algolia index.  [env var: ALGOLIA_INDEX;\n                          required]\n\n      --help              Show this message and exit.\n\nDevelopment primer\n==================\n\nBefore developing learn-astropy-librarian, set up a new Python virtual environment.\nThen, install the application with development dependencies::\n\n    make init\n\nThis command installs pre-commit hooks for code linting, installs tox, resets the tox environment, and installs the package itself.\n\nYou can run all tests through tox_::\n\n    tox\n\nYou can also run tox environments individually:\n\n- ``tox -e py`` runs unit tests with Pytest_.\n- ``tox -e lint`` runs code linters (such as flake8_ and pre-commit_).\n- ``tox -e typing`` runs mypy_ to check type annotations.\n\n.. _Pytest: https://pytest.org/en/latest/\n.. _mypy: https://mypy.readthedocs.io/en/latest/\n.. _flake8: https://flake8.pycqa.org/en/latest/\n.. _pre-commit: https://pre-commit.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastropy-learn%2Flearn-astropy-librarian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fastropy-learn%2Flearn-astropy-librarian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastropy-learn%2Flearn-astropy-librarian/lists"}