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

README and travis.yml should be linked #37

Open
calispac opened this issue Nov 23, 2017 · 5 comments
Open

README and travis.yml should be linked #37

calispac opened this issue Nov 23, 2017 · 5 comments
Assignees

Comments

@calispac
Copy link
Collaborator

In order to guaranty that installation procedure is the same in both files we should have the README and travis.yaml linked.

I propose that the README is built from the travis.yml or the other way around (if possible).
Do you have any suggestions for that ?

@dneise
Copy link
Collaborator

dneise commented Nov 23, 2017

Unfortunately I have no idea how to do this, the README is a static file.

For sphinx docu, which is build, I guess one could rig something .. but for the README, I see no nice way. A simple hyperlink into the travis.yml would be a start, I think.

I think, we struggle with this, since we try to accomplish something unusual in the Python ecosystem. Usually one would write a thing, be it an application or program or a library, which depends on other libraries. And these dependencies, one would simply note in the setup.py.

Installing the project should be: pip install
The rest is done by pip, it find the dependencies and resolves them.

This is most easy, when all dependencies are already PyPI, the Python Package Index (https://pypi.python.org/pypi).
If the dependencies themselves are only available as github repos and not available on pypi, pip in less easy to convince to resolve these dependencies ... I opened an issue about this, but must admit, I did not check for a long time, how pip behaves about this right now.

pypa/pip#3610

@calispac
Copy link
Collaborator Author

Maybe we could have test_install_script.py were we compare travis.yml and README.md
The test is then executed by pytest or travis.

@dneise
Copy link
Collaborator

dneise commented Jan 18, 2018

I have no real solution for this ... but ... in principle we should try to work towards making the install as easy as: pip install digicampipe

Then this becomes a non-issue

@dneise
Copy link
Collaborator

dneise commented Jan 18, 2018

I'd like to see, what is needed to make this repo even easer to install so I assign this one to me

@dneise dneise self-assigned this Jan 18, 2018
@dneise
Copy link
Collaborator

dneise commented Feb 12, 2018

Still I had no time to work on this ... volunteers to take this over?

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

No branches or pull requests

2 participants