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

Make the repo a package #55

Closed
ivalaginja opened this issue Aug 5, 2019 · 6 comments
Closed

Make the repo a package #55

ivalaginja opened this issue Aug 5, 2019 · 6 comments
Assignees
Labels
good first issue Good for newcomers infrastructure Work on repo infrastructure

Comments

@ivalaginja
Copy link
Collaborator

ivalaginja commented Aug 5, 2019

We should turn the repository into a full package, and we can use templates for it. The astropy package template is an option:
https://docs.astropy.org/projects/package-template/en/latest/

This would also take care of the docs (#29), while setting up continuous integration (#28) and a setup.py file.

@ivalaginja ivalaginja added good first issue Good for newcomers infrastructure Work on repo infrastructure labels Aug 5, 2019
@ivalaginja ivalaginja added this to the JOSS publication milestone Nov 18, 2019
@ivalaginja ivalaginja self-assigned this Jan 11, 2020
@ivalaginja
Copy link
Collaborator Author

The resource listed in the PR description might be a little bit of an overkill for now. We have an intro tutorial notebook and the readme as docs for now, and the CI is not super critical either. In any case, preliminary test were merged with #68 so we could try setting up just the CI. For now I will bump this off the milestone.

@ivalaginja
Copy link
Collaborator Author

ivalaginja commented Feb 4, 2020

CI was set up with #87 and docs have their own issue, so here we should focusing on releasing the repo as a package on PyPI - which we should do with the next release, which will happen with the JOSS paper.
Edit: more specifically, this needs to happen after we have a new release, so I won't work on this until after the whole JOSS thing happens.

@ivalaginja ivalaginja self-assigned this Feb 14, 2020
@ivalaginja ivalaginja modified the milestone: JOSS submission Feb 14, 2020
@ivalaginja
Copy link
Collaborator Author

@hrwakeford I just realized that we currently rely on the configfile to run anything with exoticism, so releasing it on PyPI or conda is not straightforward. Is it ok if I push this issue to a later point when we can reevaluate whether and how to make the repo an installable package?

@hrwakeford
Copy link
Member

Yes I think that if needed we can push this down the road a little, but I think that the ability to run it as a package will make it more useable so we should use this issue to work out what aspects of the config file make it less flexible and how we can change those in a way to make it more versatile.

@ivalaginja
Copy link
Collaborator Author

I fully agree, and I also think it's worth it.

@ivalaginja ivalaginja removed their assignment Feb 21, 2020
@ivalaginja ivalaginja self-assigned this Apr 1, 2020
@ivalaginja ivalaginja mentioned this issue Apr 1, 2020
@ivalaginja
Copy link
Collaborator Author

Closed with #90

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers infrastructure Work on repo infrastructure
Projects
None yet
Development

No branches or pull requests

2 participants