Reformats instance tables with HTML markers and updated details,
including country flags and notes for main instances.
Adds a JSON file for structured instance configuration.
Uses ceiling division to ensure complete pages are accounted
for when returning project results. This prevents loss of data
when the total number of projects is not perfectly divisible
by the results per page.
Corrects formatting in the Instances and Tor Hidden Services tables
of README by aligning the columns properly.
This improves readability and maintains consistency with
Markdown table formatting standards.
Expanded the README.md to document new environment variables for configuring Structables. This includes specifying the server's port and host, using an Invidious instance for YouTube content, and options for embedding untrusted iframes and setting up a custom Privacy Policy. Also introduced a debug mode for additional logging. These enhancements facilitate greater flexibility and customization for users.
Increased the project version from 0.3.14 to 0.3.15 in preparation for the latest release. This version update signifies the incorporation of minor changes or improvements since the last release.
Refactor Dockerfile to install project dependencies directly from the app directory. This change ensures the installed version matches the source code, potentially reducing mismatches between dependencies and code. Also separates the virtual environment creation step for better clarity.
Updated the project version to 0.3.14 in preparation for the upcoming release. This version increment reflects new changes or bug fixes since the previous release and ensures its availability for package managers and dependency updates.
Moved `update_data` invocation to the initialization phase of the application rather than relying on the condition of running as the main module. This change ensures data is updated consistently, regardless of whether the app is run via a WSGI server or directly. This addresses initialization issues encountered in certain deployment scenarios.
Moved path file opening and reading logic inside a conditional block to prevent attempts to access a file when no valid path is assigned. This avoids potential errors and ensures only existing files are processed.
Updated the project version to 0.3.13 to reflect recent changes or improvements. This prepares the package for a new release, ensuring that versioning remains consistent and up-to-date.
This release ensures that contests are loaded again, fixing #9.
Refactored endpoint for contest details to improve data fetching by introducing a dedicated function for retrieving contest entries via API calls. Replaced static URL strings with dynamic `url_for` to enhance routing flexibility. Updated HTML template and stylesheet to improve layout and maintainability, shifting to a more modern and responsive design. Reduced CSS complexity by removing unnecessary styles. These changes enhance usability and prepare for future layout enhancements.
Simplified contest route URLs by removing the domain, now using relative paths. Utilized a proxy function for banner URLs for enhanced handling. Revamped CSS styling for a darker theme, improving readability and updating contest display to be more flexible and mobile-friendly. Removed deprecated elements from the template to streamline the presentation.
Updated the contest data fetching logic to use the JSON API instead of scraping the HTML directly. This change improves the reliability and performance of data retrieval by utilizing a structured API endpoint.
- Replaced HTML parsing with JSON decoding
- Simplified the contest details extraction
- Updated template to display new data structure
Addresses issues with parsing inconsistencies and changes in HTML structure.
Reworked contest archive retrieval and display to enhance user experience by implementing JSON API data fetch and pagination. Simplified archive layout with modern styling and improved error handling.
- Switched from BeautifulSoup to JSON API for data fetching
- Added pagination control with page limit and offset
- Refactored UI elements for a cleaner look in archives page
- Updated CSS for better visuals and responsiveness
Added instructions to README for regularly triggering `/cron/` to keep the app's cached data updated. Modified `main.py` to initialize `global_ibles` even when using a WSGI server, ensuring data consistency. This change improves the reliability and performance of the app by maintaining up-to-date data.
Relates to #9
Corrected the country listing for the structables.bloat.cat instance
from Romania to Germany in the README.md. This ensures geographical
accuracy and up-to-date information for users referencing the
instance list.
Closes#8.
Enhanced logic for handling file embeds to ensure proper processing of
both downloadable and embedded files. Fixed issues related to condition
checks and image embedding. This improves reliability and correctness
when rendering different types of content attachments.
Fixes issue with inconsistent file embed handling.
- .gitignore adjusted to handle Docker builds:
- Added `/dist/*` to ignore all files in `dist/` except `css`.
- Increased library version to 0.3.10 in pyproject.toml.
- Removed unused bootstrap JS files.
This change ensures Docker builds exclude unnecessary files, while allowing necessary CSS files in `dist/`. Additionally, the version bump addresses new project improvements and the cleanup of orphaned files.
Bumped the project version to 0.3.9 in preparation for the next release. Adjusted .gitignore to properly ignore /dist/ directory. No major functionality changes expected.
Added URL encoding for member usernames to prevent errors with special characters in profile and Instructables URLs. Improved code readability by including docstrings for route functions, and refined HTML templates to conditionally display member location only if it exists. Updated the project version to 0.3.8.
Introduce docker-compose-example-dev.yml for development environment, enabling local builds with stricter container settings (e.g., no-new-privileges, read-only).
Update docker-compose-example.yml to pull the latest version of the structables image from the registry instead of building it locally.
Ensures consistent deployment in production and better resource management during development.
Replaced the cron job for updating data with a background
thread that runs every 5 minutes within the Flask app. Updated
version to 0.3.7.
This change ensures data is refreshed regularly without
external dependencies like cron, improving deployment
simplicity and reliability.
Introduced a new Forgejo Actions workflow to automate the Docker image build and push process on tag creation. The workflow sets up the environment, including QEMU and Buildx, logs into Docker Hub, and pushes the built image. This improvement ensures consistent and efficient Docker image deployment.
Clarified the instruction for serving static files by specifying the exact path `structables/static` instead of the container's static directory. This aims to reduce confusion and ensure accurate configuration.
Revised the URLs in the Instances section to be more concise by removing protocol prefixes. Added a new Production: Docker section to provide detailed instructions for running the application using Docker, enhancing deployment flexibility. Enhanced the Production section by renaming it to Production: Manual for clarity.
Addresses better readability and ease of use for setting up instances.
Introduced markdown rendering for the privacy policy alongside plain text support. This change enriches the presentation of the privacy policy by allowing markdown-formatted files. To facilitate this, the markdown2 library was added as a dependency, and the logic in the privacy policy route was adjusted to prioritize `.md` files over `.txt` when available. This update also includes a minor version bump and the addition of a markdown-related entry to `.gitignore`. These changes enhance the flexibility and user experience by supporting more visually structured privacy policies.
The removal of the default privacy file path (`privacy.txt`) from the environment configuration encourages explicit file path specification, accommodating the new markdown feature more seamlessly.
Incremented the project version in pyproject.toml to release new features and fixes. This version bump includes performance improvements and bug fixes that enhance the overall stability of the structables package.
Updated the privacy policy template to render HTML content safely by applying the `safe` filter to the content variable. This change ensures that HTML content stored in the `content` variable is rendered correctly in the browser, without escaping HTML tags, enhancing the page's flexibility in displaying rich content. This approach assumes the content is pre-sanitized and safe to render, mitigating potential cross-site scripting (XSS) vulnerabilities.
Enhanced the privacy policy display functionality to dynamically load content from a configurable file path. The path is specified via the `STRUCTABLES_PRIVACY_FILE` environment variable, allowing for greater flexibility and easier updates to the privacy policy without needing to redeploy the application. If the specified file is unreachable or the environment variable is unset, the system gracefully falls back to a default message, ensuring the site remains compliant with privacy policy disclosures under various circumstances. This change streamlines content management and improves the adaptability of the application to legal and policy requirements.
Introduced a Forgejo Actions workflow for automatically publishing new versions to PyPI upon pushing tags. This enhancement automates the release process for Python packages, ensuring that tagged commits trigger a build and publish sequence in a controlled, containerized environment. The workflow includes steps for setting up the environment, installing dependencies, and securely uploading the package using stored PyPI tokens.
By automating the release pipeline, this change aims to reduce manual errors, streamline version releases, and support continuous delivery practices for Python projects.
