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

Update Project Layout #1182

Merged
merged 17 commits into from Sep 30, 2019
Merged

Update Project Layout #1182

merged 17 commits into from Sep 30, 2019

Conversation

dopplershift
Copy link
Member

@dopplershift dopplershift commented Sep 30, 2019

Description Of Changes

The main thrust here is to re-arrange the repository to put tests in a top-level tests/ directory and move the package source into a top-level src/ directory rather than hang metpy/ off the repository (both outlined in #1171). This PR also does a bit of maintenance in preparation for the release:

  • Convert README.rst to markdown and eliminate the top-level README symlink
  • Eliminate test.tbl--pretty sure this never should have been committed
  • Condense our flake8 configs since pytest-flake8 can use the regular flake8 config
  • Fix version sorting in doc version chooser
  • Refresh .mailmap and authors list

Checklist

This takes the tests, and especially the test images, out of the built
wheel files. This addresses part of Unidata#1171.
@dopplershift dopplershift added Area: Infrastructure Pertains to project infrastructure (e.g. CI, linting) Type: Enhancement Enhancement to existing functionality Type: Maintenance Updates and clean ups (but not wrong) labels Sep 30, 2019
@dopplershift dopplershift added this to the 0.11 milestone Sep 30, 2019
This was so GitHub would find our README.rst, but that's not needed any
more.
Due to glob, they come out in random order, which with the amount of
versions we have is becoming quite apparent.
This is supported by PyPI now and is a lot better than RST.
I'm pretty sure this was accidentally committed awhile back. It does not
appear to be used, and it's not a useful table otherwise.
This means that when working in the root of the repository, the fact
that the current directory is on PYTHONPATH no longer causes metpy to be
available. This makes it possible to actually run tests against the
installed copy, among other benefits. Addresses part of Unidata#1171.
pytest-flake8 will use the flake8 section now (has for a bit now), so we
don't need to have the information duplicated in the pytest config.
There's no need for it to live there and be distributed, so pull it out
into a tools/ directory.
These were hiding in docstring examples.
Copy link
Contributor

@zbruick zbruick 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. I'll merge over code climate since it's just drudging up old issues due to the filepath change.

@zbruick zbruick merged commit a31af23 into Unidata:master Sep 30, 2019
@dopplershift dopplershift deleted the rearrange branch September 30, 2019 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Infrastructure Pertains to project infrastructure (e.g. CI, linting) Type: Enhancement Enhancement to existing functionality Type: Maintenance Updates and clean ups (but not wrong)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

File layout
2 participants