Skip to content

Feature/pyproject #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gregorjerse wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Feature/pyproject #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e39513
Modernize project and bump dependencies versions
gregorjerse Nov 14, 2025
a1f1152
Move manage.py to project root
gregorjerse Nov 14, 2025
4eeda05
Add basic documentation
gregorjerse Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,44 @@ Reservations
============

This is Django application used for room reservations at FRI.

Installation
============

1. Clone the repository.

.. code-block:: bash

git clone https://github.com/UL-FRI/reservations.git


2. Navigate to the project directory and install the required dependencies.

.. code-block:: bash

cd reservations
uv sync

3. Create/update the database.

.. code-block:: bash

uv run manage.py migrate

4. Create superuser account.

.. code-block:: bash

uv run manage.py createsuperuser

5. Run the development server.
.. code-block:: bash

uv run manage.py runserver
Copy link

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent indentation in code block. The indentation should match the pattern used in other code blocks (lines 12-14, 20-22, etc.) where content is indented with spaces after the directive.

Suggested change
uv run manage.py runserver
uv run manage.py runserver

Copilot uses AI. Check for mistakes.

Usage
=====

The administration interface can be accessed at ``localhhost:8000/admin/``.
Copy link

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected spelling of 'localhhost' to 'localhost'.

Suggested change
The administration interface can be accessed at ``localhhost:8000/admin/``.
The administration interface can be accessed at ``localhost:8000/admin/``.

Copilot uses AI. Check for mistakes.

The API endpoints are available at ``localhost:8000/api/``.
2 changes: 1 addition & 1 deletion tests/manage.py → manage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

def main():
"""Run administrative tasks."""
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings")
try:
from django.core.management import execute_from_command_line
except ImportError as exc:
Expand Down
50 changes: 50 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
[build-system]
requires = ["setuptools >= 80.9.0", "setuptools_scm >= 9.2.2"]
build-backend = "setuptools.build_meta"

[project]
name = "reservations"
description = "Open source reservation system written in Django"
authors = [{ name = "Gregor Jerše", email = "gregor@jerse.info" }, { name = "Gašper Fele-Žorž", email = "polz@not.si" }]
dynamic = ["version"]
readme = "README.rst"
license = "GPL-3.0-or-later"
requires-python = ">=3.13, <3.15"
keywords = ["reservations", "FRI", "university", "api", "django", "rest-framework"]
classifiers = [
"Development Status :: 5 - Production",
"Environment :: Web Environment",
"Framework :: Django",
"Intended Audience :: Developers",
"Topic :: Internet :: WWW/HTTP",
"Topic :: Internet :: WWW/HTTP :: Dynamic Content",
"Topic :: Internet :: WWW/HTTP :: HTTP Servers",
"Topic :: Software Development :: Libraries :: Application Frameworks",
"Topic :: Software Development :: Libraries :: Python Modules",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3.14",
]

dependencies = [
"Django~=5.2.8",
"django-guardian~=3.2.0",
"djangorestframework~=3.16.1",
"django-filter~=25.2",
"django-autocomplete-light~=3.12.1",
"django-debug-toolbar~=6.1.0",
]

[project.optional-dependencies]
postgres = ["psycopg[binary] ~= 3.2.12"]
docs = ["sphinx", "sphinx-pyproject"]
package = ["twine", "build"]
test = ["ruff", "pytest-cov"]
devel = ["ipython", "types-tqdm", ]
[project.urls]
repository = "https://github.com/UL-FRI/reservations"
documentation = "https://github.com/UL-FRI/reservations"

[tool.setuptools_scm]
24 changes: 0 additions & 24 deletions setup.cfg
View file
Open in desktop

This file was deleted.

73 changes: 0 additions & 73 deletions setup.py
View file
Open in desktop

This file was deleted.

32 changes: 0 additions & 32 deletions src/reservations/__about__.py
View file
Open in desktop

This file was deleted.

14 changes: 3 additions & 11 deletions tests/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
"""
Django settings for tests project.

Generated by 'django-admin startproject' using Django 4.0.2.

For more information on this file, see
https://docs.djangoproject.com/en/4.0/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/4.0/ref/settings/
Django settings for local development and testing.
"""

from pathlib import Path
Expand Down Expand Up @@ -57,7 +49,7 @@
"django.middleware.clickjacking.XFrameOptionsMiddleware",
]

ROOT_URLCONF = "urls"
ROOT_URLCONF = "tests.urls"

TEMPLATES = [
{
Expand All @@ -75,7 +67,7 @@
},
]

WSGI_APPLICATION = "wsgi.application"
WSGI_APPLICATION = "tests.wsgi.application"


# Database
Expand Down
Loading