Skip to content

add license, docs, authors to manifest, exclude spa files #580

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Sep 17, 2018
Merged

add license, docs, authors to manifest, exclude spa files #580

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0b80e4b
add license, docs, authors to manifest
wholmgren Sep 16, 2018
5b679c4
update whatsnew [skip ci]
wholmgren Sep 16, 2018
5a26cbf
Merge remote-tracking branch 'pvlib/master' into manifest
wholmgren Sep 16, 2018
37308f9
remove prune tutorials, remove spa_c_files
wholmgren Sep 16, 2018
01e8c3e
fix spa_c_files
wholmgren Sep 16, 2018
6fbdf66
rework to use graft
wholmgren Sep 16, 2018
d35a0fc
more flexible spa exclude
wholmgren Sep 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions MANIFEST.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,23 @@
#include *.txt
include AUTHORS.md
include LICENSE
include README.md

include versioneer.py
include pvlib/_version.py
Copy link
Member

Choose a reason for hiding this comment

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

AFAIK, this line is not necessary, since pvlib is a package, and is already listed in setup.py

Copy link
Member Author

@wholmgren wholmgren Sep 16, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

I agree, but I believe this was part of the versioneer setup instructions. Other projects include this line as well. So I recommend we leave it for now.


recursive-include pvlib/data *
include README.md

include pvlib/spa_c_files/*.h
Copy link
Member

Choose a reason for hiding this comment

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

IMO this should be removed, b/c I don't think there are any header files are in spa_c_files that should be distributed, and this might accidentally cause the NREL SPA C-files to be distributed without their consent.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree. Do we need to replace it with anything else so that the subpackage is properly distributed (minus the NREL files)?

For the record... the only way this would cause the NREL files to be distributed is if the files were manually added to the pvlib/spa_c_files directory before making a release. I usually make a fresh clone of pvlib/pvlib-python before making a release so that things like this don't happen. It's possible that the files are in a few releases in the 0.2-0.3 era, but I'd be surprised if they are in any of the 0.4-0.5 releases.


#recursive-include docs *.txt
recursive-exclude * __pycache__
recursive-exclude * *.py[co]

recursive-include docs *
prune docs/tutorials
Copy link
Member

Choose a reason for hiding this comment

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

just curious, why prune the Jupyter notebook tutorials? IMO these could be run locally more interactively, than viewing them in nbviewer or GitHub. IMO pvlib should include these in the sdist.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, better to include them.

prune docs/sphinx/build
prune docs/sphinx/source/generated
# all doc figures created by doc build
prune docs/sphinx/source/savefig

global-exclude .DS_Store
global-exclude .ipynb_checkpoints/*
2 changes: 2 additions & 0 deletions docs/sphinx/source/whatsnew/v0.6.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,8 @@ Bug fixes
* Fixed bug in tracking.singleaxis that mistakenly assigned nan values when
the Sun was still above the horizon. No effect on systems with axis_tilt=0.
(:issue:`569`)
* Source distribution did not contain LICENSE file. Added LICENSE, AUTHORS.md,
and some docs to MANIFEST. (:issue:`579`)


Documentation
Expand Down