Skip to content

Make mysqlclient a production-only requirement#709

Merged
AdrianDAlessandro merged 4 commits into
direct-framework:cw26-hack-dayfrom
kevinrue:kra-574
Apr 30, 2026
Merged

Make mysqlclient a production-only requirement#709
AdrianDAlessandro merged 4 commits into
direct-framework:cw26-hack-dayfrom
kevinrue:kra-574

Conversation

@kevinrue
Copy link
Copy Markdown

Description

Following instructions in the README as a potential first time contributor, I ran into issue #574

This PR implements the solution discussed in the issue, namely:

  • remove mysqlclient from core requirements
  • create a new set of 'production' requirements that includes only mysqlclient
  • ran pip-compile to regenerate core and dev requirements
  • Because I haven't installed third-party MySQLclient yet, manully created and edited prod-requirements.txt to what it should look like. Once I confirm that the dev-requirements work, I'll try again pip-compile-ing the prod-requirements.txt file properly.

Also update the README file to add a one-time setup step running 'migrate' to initialise database tables.

Please include a summary of the change and which issue is fixed (if any). Please also
include relevant motivation and context. List any dependencies that are required for
this change.

Fixes #574

Type of change

  • Documentation (non-breaking change that adds or improves the documentation)
  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Technical work (non-breaking, change which is work as part of a new feature)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass (eg. python -m pytest)
  • The documentation builds and looks OK (eg. mkdocs serve)
  • Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

not applicable

  • Code is commented, particularly in hard-to-understand areas
  • Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

@kevinrue kevinrue changed the base branch from main to cw26-hack-day April 30, 2026 11:13
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@AdrianDAlessandro AdrianDAlessandro mentioned this pull request Apr 30, 2026
11 tasks
@AdrianDAlessandro AdrianDAlessandro changed the title Fix issue #574 Make mysqlclient a production-only requirement Apr 30, 2026
Copy link
Copy Markdown
Collaborator

@AdrianDAlessandro AdrianDAlessandro left a comment

Choose a reason for hiding this comment

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

Thanks!

@AdrianDAlessandro AdrianDAlessandro merged commit 945eca3 into direct-framework:cw26-hack-day Apr 30, 2026
1 check passed
@kevinrue kevinrue deleted the kra-574 branch April 30, 2026 14:09
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.

[BUG] Installation instructions are incomplete

2 participants