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

Modify setup.py handling #531

Merged
merged 5 commits into from
Apr 12, 2017
Merged

Modify setup.py handling #531

merged 5 commits into from
Apr 12, 2017

Conversation

mbeacom
Copy link
Collaborator

@mbeacom mbeacom commented Apr 7, 2017

The goal of this PR is to implement changes to setup.py to include:

  • Installation extras option: optional to install all optional dependencies via pip.
  • Installation extras option: test to install all test dependencies via pip.
  • Installation extras option: docs to install all documentation dependencies via pip.
  • Classification changes/additions.
  • Add PyTest setup.py command, to enable python setup.py test to install testing dependencies and run testing suite.
  • Add Sphinx BuildDoc setup.py command, to enable python setup.py build_doc to build HTML documentation.

Simple additions to documentation:

  • Running the test suite.
  • Building the documentation.
  • Installing all optional requirements via pip.
  • Installing all documentation-building requirements via pip.
  • Installing all test requirements via pip.

Misc modifications:

  • Add shell env type specification header to makehtml.sh to make it executable.
  • Change documentation build structure to build inside of the repo directory at: ./docs/build/ and simply ignore the build directory.

Steps to test

  • Assert that python setup.py test successfully installs the moviepy test dependencies and runs the test suite.
  • Assert that pip install -e .[docs]; python setup.py build_docs -E; open docs/build/html/index.html successfully installs the moviepy doc dependencies and builds the documentation.
  • Assert that pip install -e .[optional] successfully installs all of the moviepy dependencies.
  • Assert that pip install -e .[test] successfully installs all of test related moviepy dependencies.
  • Assert that pip install -e . successfully installs moviepy base.

@mbeacom mbeacom changed the title Modify requirement handling Modify requirement and setup.py handling Apr 7, 2017
@mbeacom mbeacom added the enhancement Positive change that does not change the API, i.e. improved performance, using less memory etc. label Apr 7, 2017
@mbeacom mbeacom added this to the Release v0.2.3.2 milestone Apr 7, 2017
@mbeacom mbeacom added the WIP label Apr 7, 2017
@mbeacom mbeacom changed the title Modify requirement and setup.py handling Modify setup.py handling Apr 7, 2017
@mbeacom mbeacom removed the WIP label Apr 7, 2017
@mbeacom mbeacom requested a review from a user April 7, 2017 20:32
@coveralls
Copy link

coveralls commented Apr 7, 2017

Coverage Status

Coverage remained the same at 50.282% when pulling c6fec68 on mbeacom:dev-reqs-setup into b76beb4 on Zulko:master.

@mbeacom mbeacom self-assigned this Apr 7, 2017
@ghost
Copy link

ghost commented Apr 7, 2017

this is a bit beyond my current skill level, but it looks good to me.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

looks good to me.

Copy link
Owner

@Zulko Zulko left a comment

Choose a reason for hiding this comment

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

To me too. I just hope it doesn't complicate installation via other means than pip, but it doesn't seem so.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 53.104% when pulling edfc8bb on mbeacom:dev-reqs-setup into 7216089 on Zulko:master.

2 similar comments
@coveralls
Copy link

Coverage Status

Coverage remained the same at 53.104% when pulling edfc8bb on mbeacom:dev-reqs-setup into 7216089 on Zulko:master.

@coveralls
Copy link

coveralls commented Apr 12, 2017

Coverage Status

Coverage remained the same at 53.104% when pulling edfc8bb on mbeacom:dev-reqs-setup into 7216089 on Zulko:master.

@coveralls
Copy link

coveralls commented Apr 12, 2017

Coverage Status

Coverage remained the same at 53.104% when pulling 7a3cc62 on mbeacom:dev-reqs-setup into 7216089 on Zulko:master.

@mbeacom mbeacom merged commit f6ceee3 into Zulko:master Apr 12, 2017
@mbeacom mbeacom deleted the dev-reqs-setup branch April 12, 2017 17:07
@mbeacom mbeacom restored the dev-reqs-setup branch April 12, 2017 17:07
@mbeacom mbeacom mentioned this pull request Apr 12, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Positive change that does not change the API, i.e. improved performance, using less memory etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants