-
Notifications
You must be signed in to change notification settings - Fork 26
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
plugin complement #409
plugin complement #409
Conversation
bbef8ab
to
3feba43
Compare
Codecov Report
@@ Coverage Diff @@
## master #409 +/- ##
==========================================
+ Coverage 90.89% 91.90% +1.00%
==========================================
Files 201 203 +2
Lines 8153 8409 +256
Branches 854 915 +61
==========================================
+ Hits 7411 7728 +317
+ Misses 586 504 -82
- Partials 156 177 +21
Continue to review full report at Codecov.
|
Strangely enough, GitHub workflows have now problems finding tests/testing_utilities.
…y one is available
get_plugin_configuration_file_list() is enough for the job.
…ration_file_list())
90237d7
to
c42545f
Compare
c42545f
to
7bb48ed
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this PR!
This is really what I had in mind for the plugin features.
I have a small suggestion for the documentation (c.f. my only comment).
The command :code:`poetry build` will create a :code:`dist` folder with two files: | ||
|
||
:code:`ST_drive_models-1.0.0.tar.gz` and :code:`ST_drive_models-1.0.0-py3-none-any.whl` | ||
(or something like this). | ||
|
||
You may then have sent any of those two files to another user, who may then install your models | ||
using :code:`pip` with: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the section "Publishing" I would underline that to publish on PyPi the package name will be the one provided in the field name
in the pyproject.toml
. Therefore, the publisher shall check that the chosen package name is not already taken on PyPi.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. Done in a64d130.
This PR implements an enhanced plugin system and closes #393.
It contains following modifications:
fastoad.plugins
as group name instead offastoad_model
fastoad_model
is still usable, though not mentioned anymore in RTD documentation. It works the same as before, i.e. it expects to have only FAST-OAD modules in the declared plugin package.FastoadLoader
. Then the loading is not made anymore at startup, which greatly speeds up commands likefastoad -h
orfastoad -v
.fastoad.api
now contains acreate_notebooks()
method.contest.py
. It has been rather painful to achieve that 😅.pkg_resources
has been removed to useimportlib.metadata
as it is now recommended.tests/testing_utilities.py
has been moved tosrc/fastoad/_utils/testing.py
so that there shouldn't be anymore warning when importing copied models in other projects.