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

Python packaging #134

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Python packaging #134

wants to merge 4 commits into from

Conversation

ashwinvis
Copy link

Packages all plugins (*.py), css and html data has to be explicitly added if it would be published on PyPI.

Fixes #82.
Previous attempt #97.

Pelican 5.x
$ sed -i 's/import\ pelican.signals/from\ pelican\ import\ signals/g' plugins/m/*
$ sed -i 's/pelican\.signals\./signals\./g' plugins/m/*
@codecov
Copy link

codecov bot commented Apr 23, 2020

Codecov Report

Merging #134 (55b8870) into master (9385194) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #134   +/-   ##
=======================================
  Coverage   98.28%   98.28%           
=======================================
  Files          27       28    +1     
  Lines        6646     6647    +1     
  Branches       44       44           
=======================================
+ Hits         6532     6533    +1     
  Misses        114      114           
Impacted Files Coverage Δ
plugins/m/__init__.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9385194...55b8870. Read the comment docs.

@MinchinWeb
Copy link

You probably want to add the Classifiers Framework :: Pelican, Framework :: Pelican :: Themes, and Framework :: Pelican :: Plugins (as appropriate).

@sizmailov
Copy link
Contributor

sizmailov commented Jun 29, 2020

This PR does not have entry_points.console_scripts in setup.cfg.
it would be nice to have aliases for documentation/python.py like mcss-python (+ same for doxygen).

@ashwinvis
Copy link
Author

ashwinvis commented Jun 29, 2020

@sizmailov That can be difficult. Entry points are added to packages, and with this PR every file under "plugins" is regarded as a package. This is important for the next pelican release which supports import-able plugins.

While documentation can be added to the package source distribution, setting it as an entry point is not possible ... unless the documentation is an installable python package - which it is not.

@sizmailov
Copy link
Contributor

sizmailov commented Jun 29, 2020

IMO documentation is essential part of mcss and should be included in package whatever it takes.

You are right that turning documentation into a proper python package probably should be addressed in another PR (and this one should be rebased on top of it).

(Also note that CI did not pass, rebase on master should help)

@mosra mosra added the needs fermenting Not sure what to do with this yet, give it time. label Jan 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs fermenting Not sure what to do with this yet, give it time.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

missing setup.py-files for packaging
4 participants