mosra / m.css

A no-nonsense, no-JavaScript CSS framework, site and documentation theme for content-oriented websites

https://mcss.mosra.cz

Other

406 stars 92 forks source link

Python packaging #134

Open ashwinvis opened 4 years ago

ashwinvis commented 4 years ago

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.

codecov[bot] commented 4 years ago

Codecov Report

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

@@           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 commented 4 years ago

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

sizmailov commented 4 years ago

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 commented 4 years ago

@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 commented 4 years ago

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)