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.

Sign up for GitHub

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

Jump to bottom

organize as a Python package #59

Open

gschare opened this issue Nov 2, 2020 · 1 comment

Assignees

Labels

enhancement question

Contributor

gschare commented Nov 2, 2020

It may be prudent to structure this repository according to the standard Python package organization.

Arguments for:

Make it easier for users to use the repo
Reduce clutter
Increased organization

Arguments against:

Our project doesn't necessarily fit the typical notion of a Python package
It's not clear how exactly this would improve usability
Where would the other stuff in our repo go? Or maybe it should be entirely moved out if it's not specifically to do with the Python representation of the manuscript

gschare added enhancement question labels

gschare self-assigned this

Contributor Author

gschare commented Nov 14, 2020

I'm leaning more and more towards doing this. Here would be the structure:

Pipfile
src/
  |-- __init__.py
  |-- manuscript.py
  |-- entry.py
  |-- utils.py
  |-- update.py
  |-- annotations.xslt (rename this to something more helpful)
test/
  |-- __init__.py
  |-- context.py
  |-- test_manuscript.py
  |-- test_entry.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment