Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thomersch/openstreetmap-calendar
osmcal, a Collaborative Calendar for OpenStreetMap-related Events
https://github.com/thomersch/openstreetmap-calendar
calendar openstreetmap
Last synced: 2 months ago
JSON representation
osmcal, a Collaborative Calendar for OpenStreetMap-related Events
- Host: GitHub
- URL: https://github.com/thomersch/openstreetmap-calendar
- Owner: thomersch
- License: apache-2.0
- Created: 2019-07-30T16:01:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T10:56:21.000Z (9 months ago)
- Last Synced: 2024-04-05T11:45:16.085Z (9 months ago)
- Topics: calendar, openstreetmap
- Language: Python
- Homepage: https://osmcal.org
- Size: 2.29 MB
- Stars: 33
- Watchers: 5
- Forks: 9
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - thomersch/openstreetmap-calendar - osmcal, a Collaborative Calendar for OpenStreetMap-related Events (others)
README
# OpenStreetMap Calendar
A simple calendar for tracking OpenStreetMap-related activities.
## Principles
* Less, but better.
* Work hard and be nice to people.
## User Documentation
Please look at [OpenStreetMap Calendar Documentation](https://osmcal.org/documentation/) for information about integration and API.
## Developer Documentation
The repo contains a [dev container](https://containers.dev) configuration, so you can develop without having to install all the dependencies on your machine manually. VS Code and PyCharm/IntelliJ have integrated support and you can even use Github Codespaces.
Alternatively you can install like any other Python/Django project. We're using [poetry](https://python-poetry.org) for managing dependencies. Please look at their documentation for installation instructions.
We support Python ≥ 3.11 and PostgreSQL ≥ 15. (Older versions might work, but no guarantees).
### Database
You need a running PostgreSQL database with PostGIS installed. If you're using the dev container, the DB is automatically started and set up.
If you set this up manually, make sure you have an empty DB before starting. By default we're using the `osmcal` for user and DB with no password set. For more details, check `osmcal/settings.py`.
### Running Tests
```
make test
```
### Developer Server
In order to facilitate testing, you can use a fake login locally without having to setup OAuth first. To do this, scroll down to the footer. In debug mode, there is a link called "Mock login" which will instantly log you in as a normal user.
To prepare for application launch run the database migrations:
```
make migrate
```
and then the local server:
```
make devserver
```
If you need test data, you can load some using:
```
make fixtures
```
## API Documentation
The API is described using OpenAPI 3, the schema is located in `/api/schema/`. The currently live version is [visible here](https://osmcal.org/static/api.html).