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

Addition of poethepoet package to manage repetitive development tasks #303

Closed
wants to merge 9 commits into from

Conversation

qlrd
Copy link
Contributor

@qlrd qlrd commented Dec 31, 2023

Description

Poe the poet

Poethepoet is a nice task runner that works well with poetry.

We can define a [tool.poe.tasks] section on pyproject.toml and many tasks with the following
format:

[tool.poe.tasks]
_task1 = "<some poetry command>"
_task2 = "<some shell command>"
task_A = ["_task1", "_task2"]
_task3 = "<some poetry command>"
_task4 = "<some shell command>"
task_B = ["_task3", "_task4"]

Where the prepended _ means that specific task cannot be called directly and commands can be nested in a array; and a task without _ can be called by:

poetry run poe task_A
poetry run poe task_B

Maybe its save some time for developers, mainly in formatting, lint, testing and simulation commands.

If approved, it's worth to update README with these "tasks"

Simulator

To enable the poe task manager in the simulator, it was necessary to change the way in which it looked for the path of some modules, from a relative way, to an absolute way.

Lint tests

When wrapping lint into multiple folders, we include some lints in the testing directory

What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other: improvements on development process

Copy link

codecov bot commented Dec 31, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7add64a) 92.24% compared to head (311998d) 92.24%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #303   +/-   ##
========================================
  Coverage    92.24%   92.24%           
========================================
  Files           42       42           
  Lines         5290     5290           
========================================
  Hits          4880     4880           
  Misses         410      410           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@qlrd qlrd closed this Jan 4, 2024
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.

1 participant