https://github.com/umd-lib/aspace-sitemap
ArchivesSpace sitemap.xml
https://github.com/umd-lib/aspace-sitemap
Last synced: 7 days ago
JSON representation
ArchivesSpace sitemap.xml
- Host: GitHub
- URL: https://github.com/umd-lib/aspace-sitemap
- Owner: umd-lib
- License: apache-2.0
- Created: 2022-01-18T17:00:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-28T11:40:15.000Z (over 1 year ago)
- Last Synced: 2025-02-27T12:41:55.519Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# aspace-sitemap
Python 3 Flask application to generate and serve a sitemap.xml file for
ArchivesSpace public interface using the ArchivesSpace API and the
ArchivesSnake Library.
## Requires
* Python 3
## Running the Webapp
```bash
# create a .env file (then manually update environment variables)
cp .env-template .env
```
### Running locally, directly with flask
```bash
# install requirements
pyenv install --skip-existing $(cat .python-version)
python -m venv .venv --prompt "$(basename "$PWD")-py$(cat .python-version)"
source .venv/bin/activate
pip install -r requirements.txt
# run the app with Flask
flask run
```
### Running locally, in Docker
```bash
docker build -t aspace-sitemap .
docker run -it --rm -p 5000:5000 --env-file=.env --read-only aspace-sitemap
```
### Endpoints
This will start the webapp listening on the default port 5000 on localhost
(127.0.0.1), and running in [Flask's debug mode].
Root endpoint (just returns `{status: ok}` to all requests):
/ping endpoint (just returns `{status: ok}` to all requests):
/sitemap.py endpoint:
[Flask's debug mode]: https://flask.palletsprojects.com/en/2.0.x/quickstart/#debug-mode
## License
See the [LICENSE](LICENSE.txt) file for license rights and limitations.