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

Provide names.csv with the packge #11

Open
KonradUdoHannes opened this issue Jul 31, 2021 · 0 comments
Open

Provide names.csv with the packge #11

KonradUdoHannes opened this issue Jul 31, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@KonradUdoHannes
Copy link
Collaborator

The repository contains a names.csv file with reference data on the top level. It might be desirable to deliver this together with the source distribution inside the package. This could be done by the following steps.

  • move the names.csv inside the package, for instance into a opencity/data/ folder
  • inside the source code find the file relative to other source code files use __file__
  • ensure that opencity/data/ (or just the .csv file in it) is included in the MANIFEST.in
  • optional but recommended: add a test to opencity/tests/ that uses the included filedirection, i.e. that does not have a fallback to downloading the remote file. This way the CI will always check whether this file inclusion worked as well.
@KonradUdoHannes KonradUdoHannes added the enhancement New feature or request label Jul 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant