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

Clean up files in misc/ #150

Merged
merged 4 commits into from
May 3, 2017
Merged

Clean up files in misc/ #150

merged 4 commits into from
May 3, 2017

Conversation

Freso
Copy link
Member

@Freso Freso commented Apr 28, 2017

See individual commit messages for reasoning. (Also somewhat related to #5 in that some of this is removing scripts from elsewhere that are likely better maintained in their own repositories/domains.)

Stragglers that I'm unsure about:

  • misc/header.py: Template file for new files with GPL copyright blurb and vi mode lines.
  • misc/offsets.py: Script to get some statistics about common offsets. Might still be relevant/useful and doesn't seem like code suited for elsewhere.
  • misc/pycheckerrc: Configuration file for pychecker. Doesn't seem to be referenced anywhere in the code. I'm leaning towards removing this: if we want a configuration file for a Python linter, it should probably be in a place where CI would pick it (either automatically or because we direct it there). flake8 or pylint seems to be the choices to go for here though, neither of which are pychecker. But maybe hold onto pycheckerrc until we do implement something like this so we can crossreference the settings? Or just drop this since whipper has already moved away where morituri was in 2009 (when the file was added and last modified).
  • misc/whipper-uninstalled: A script to help run whipper without installing it. Not referenced anywhere and seems like something that Python virtual environments are perfectly suited for now. My vote is to either toss the script or rewrite it to use virtualenv (leaning towards the former).

Freso added 3 commits April 28, 2017 10:55
pep8.py was added in 2012. Since then, we now have flake8 and a number
of other really good PEP 8 (and other style, best practice, etc.) code
checkers/linters. It doesn't make sense to track this directly in the
repository. If we want to do automated code style/sanity checking, we
should add a dependency on an actually maintained program/script rather
than keeping it locally in the repository.
Was added in 2009 and not updated since. There are several Python
coverage tools out there, and the current ./COVERAGE doesn't seem to be
generated using this script either.
Not actually used by anything in the current codebase and PyChecker
doesn't seem to be the recommended Python code style checker or linting
tool currently. If we need a configuration file for another tool later
on, we can make one then based on current need and wants.
@Freso
Copy link
Member Author

Freso commented Apr 28, 2017

@JoeLametta said to toss whipper-uninstalled and pycheckerrc on IRC. I will keep the other two for now and consider the PR Ready for Merge™.

A script that sets up an environment for running whipper without
actually installing it. With the clean ups that have happened to whipper
as well as later developments in the Python eco system, simply setting
up a virtualenv and running whipper from within that seems like a more
reasonable approach at this time.

This also fixes #47 by
removing the "morituri-uninstalled mode" completely. :)
@JoeLametta JoeLametta merged commit f0692ba into whipper-team:master May 3, 2017
@JoeLametta
Copy link
Collaborator

Merged, thanks.

@Freso Freso deleted the misc-file-cleanup branch May 3, 2017 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants