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

Simpler custom configuration and better related docs #1109

Merged
merged 26 commits into from
Apr 27, 2020

Conversation

mgaitan
Copy link
Collaborator

@mgaitan mgaitan commented Mar 25, 2020

  • I have properly documented new or changed features in the documention or in the docstrings

This is a proposal fix for #793 (and probably #1107, #883 and more issues related to custom config). It seems windows users have a lot of troubles particularly with the setup of ImageMagick and the instructions in the readme were totally outdated and complicated (even with a duplicated paragraph).

The point is that, currently, the way to setup a "custom" path to the external tools is through environment variables and not editing a python module as the README said.

In addition to update the doc (please, feel free to correct/improve it, english is not my best skill)
, I deleted the config_default.py module because is fairly useless. Environment variables are now documented, including how to set them via python or, optionally, via a dotenv file.

As the config is via envars, functions to read/change config variables has no sense and were also removed.

@coveralls
Copy link

coveralls commented Mar 25, 2020

Coverage Status

Coverage increased (+0.01%) to 64.796% when pulling 3d313ab on mgaitan:793_custom_configs into 8d14ef9 on Zulko:master.

@tburrows13 tburrows13 added the feature New addition to the API i.e. a new class, method or parameter. label Mar 25, 2020
@tburrows13 tburrows13 changed the base branch from v2 to master March 26, 2020 12:33
@tburrows13 tburrows13 added this to the Release v2.0.0 milestone Mar 26, 2020
@mgaitan mgaitan requested a review from keikoro April 1, 2020 05:34
@mgaitan
Copy link
Collaborator Author

mgaitan commented Apr 4, 2020

I would like to receive some feedback on this, guys. And please feel free to reword or correct the prose, particularly in the docs.

README.rst Show resolved Hide resolved
tburrows13 and others added 2 commits April 5, 2020 01:45
Add changelog entry
Fix some string formatting errors
docs/install.rst Outdated Show resolved Hide resolved
@tburrows13
Copy link
Collaborator

I've gone through your changes and made some tweaks to the wording in a few places. You've made a great improvement, and I think that it will now be much easier for users (especially windows users) to start using MoviePy.

Once you've had a look at my comments and we've sorted them, then I'm happy to merge.

@tburrows13 tburrows13 added the lib-misc Issues pertaining to misc. 3rd-party libraries. label Apr 5, 2020
@mgaitan
Copy link
Collaborator Author

mgaitan commented Apr 10, 2020

@tburrows13 I've tried to clarify the example for setting config via dotenv and added the check() tip.

please, check and merge.

# Conflicts:
#	CHANGELOG.md
#	docs/install.rst
#	moviepy/config_defaults.py
#	moviepy/video/io/ffmpeg_tools.py
@tburrows13 tburrows13 linked an issue Apr 27, 2020 that may be closed by this pull request
@tburrows13 tburrows13 merged commit 9cc52c2 into Zulko:master Apr 27, 2020
@keikoro keikoro added breaking-change Must not merge without proper approval. Requires full documentation (own section) in the changelog. and removed breaking-change labels Oct 3, 2020
@keikoro keikoro mentioned this pull request Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change Must not merge without proper approval. Requires full documentation (own section) in the changelog. feature New addition to the API i.e. a new class, method or parameter. lib-misc Issues pertaining to misc. 3rd-party libraries.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

config_defaults.py is a poor UX
4 participants