Skip to content
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.

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

Suggested changes based on my setup experience #945

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Blackoverflow
Copy link

@Blackoverflow Blackoverflow commented Jan 28, 2025

Hi

I try myself at the froide development setup right now.

While doing this, I try to improve the documentation.

Proposed changes so far:

  • changed pyproject.toml classifiers
    because they puzzled me
  • added ruff as test dependency
    because this allows me to avoid a system wide installation of ruff, which is needed for make test
  • updated readme setup description, based on what the 'Froide CI' Github Job does
    because it was outdated and incomplete
  • added sections about required system tools and libs
    because its tedious to find out one after another
  • updated readme 'Update dependencies' using the make target
  • removed a version reference from docs/about.rst
    it was outdated and it would only get outdated again

pnpm install and pnpm run build failed at the exifeader postinstall script until I also installed node 20 and npm.
Any ideas how to get by only with @pnpm/exe ?

After running the manage.py setup steps:

Of all the system dependencies that are installed in 'Froide CI', I only installed 'libpoppler-cpp-dev' so far.

I propose to add a make target 'setup' and reference it from the readme. I think this would be less likely to become outdated.

I also plan to update the documentation. First of all docs/development.rst which seems to be completely outdated.

Please give feedback if this is helpful to you and give pointers what else is important for development setup.

Blackoverflow added 6 commits January 28, 2025 23:33
- Intended Audience are not Developers
- Change Python version to match "requires-python"
- add required tools and libs
- update setup based on Froide CI
- update "Upgrade dependencies" based on autogeneration comments
- remove outdated Django version reference
@krmax44
Copy link
Member

krmax44 commented Feb 10, 2025

Thanks! I assume the failing tests have something to do with --reuse-db. What happens when you run pytest --create-db?

@Blackoverflow
Copy link
Author

Thanks! I assume the failing tests have something to do with --reuse-db. What happens when you run pytest --create-db?

That assumption was on the mark. pytest --create-db ran green and now make test also runs green. Thank you.
Not sure yet how I document this, so future setups will regard this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants