https://github.com/umd-lib/ipmanager-django
Django implementation of the University of Maryland Libraries' standalone IP Manager Service
https://github.com/umd-lib/ipmanager-django
Last synced: 12 months ago
JSON representation
Django implementation of the University of Maryland Libraries' standalone IP Manager Service
- Host: GitHub
- URL: https://github.com/umd-lib/ipmanager-django
- Owner: umd-lib
- License: apache-2.0
- Created: 2025-01-05T23:53:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-01T14:11:18.000Z (about 1 year ago)
- Last Synced: 2025-05-07T05:05:34.859Z (about 1 year ago)
- Language: Python
- Size: 138 KB
- Stars: 0
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ipmanager-django
Django implementation of the University of Maryland Libraries' standalone
IP Manager Service. The service provides both an Administrator UI and a REST
API interface for IP lookups.
## Development Setup
Please see [DevelopmentEnvironmentLocal](docs/DevelopmentEnvironmentLocal.md) for
a full tutorial on how to set up this application (including SAML) to run
on your local machine.
To run the webapp using the built-in web server:
```zsh
src/manage.py runserver
```
The application will be running at
To use an alternate port, specify it after the `runserver` command:
```zsh
src/manage.py runserver 5999
```
Then the application will be running at
### Tests
This project uses the [pytest] test framework, in conjunction with the
[pytest-django] plugin, for testing. Tests are located in the [tests](tests/)
directory.
To run the tests:
```zsh
pytest
```
Configuration for `pytest` is maintained in the [pyproject.toml] file.
### Code Formatting and Linting
This project uses [ruff] for code format checking and code linting.
To run the linter:
```zsh
ruff check
```
To run the formatter:
```zsh
# show what would be changed without making the changes
ruff format --diff
# automatically apply the changes
ruff format
```
Configuration for `ruff` is maintained in the [pyproject.toml] file.
## History
This project began life as a Java servlet application that was tightly
integrated with the UMD Libraries' Fedora 2 digital repository application.
In 2022, it was reimplemented as a Ruby on Rails application, and expanded
to include a more user-friendly admin UI. The API was also changed from
the XML format used by the original application to a more modern JSON
implementation.
In 2025, it is being reimplemented again, this time using Python and the
Django framework.
## License
See the [LICENSE](LICENSE) file for license rights and limitations (Apache 2.0).
[pyproject.toml]: pyproject.toml
[pytest]: https://docs.pytest.org/en/stable/
[pytest-django]: https://pytest-django.readthedocs.io/en/latest/
[ruff]: https://docs.astral.sh/ruff/