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

Document how to install and how to run examples #11

Open
femtotrader opened this issue Feb 7, 2021 · 6 comments
Open

Document how to install and how to run examples #11

femtotrader opened this issue Feb 7, 2021 · 6 comments

Comments

@femtotrader
Copy link
Contributor

Hello,

Maybe README.md should show how to install termgraph

pip install git+https://github.com/sgeisler/termgraph/

or

git clone https://github.com/sgeisler/termgraph/
...

It could show how to do it for those who are not using Poetry.

Documentation could also show how to run examples directly from commandline.

python examples/animation.py
python examples/static.py

Kind regards

@femtotrader
Copy link
Contributor Author

Related issue #6

@sgeisler
Copy link
Owner

sgeisler commented Feb 7, 2021

PRs are welcome ;)

@femtotrader
Copy link
Contributor Author

Not sure how you run examples on your side

python examples\animation.py
Traceback (most recent call last):
  File "examples\animation.py", line 5, in <module>
    from examples import load_data
ModuleNotFoundError: No module named 'examples'

@sgeisler
Copy link
Owner

sgeisler commented Feb 7, 2021

It somehow works in pycharm, easy fix: copy and paste the load_data function. Alternatively there seem to be hacky ways to load sibling/parent modules.

@femtotrader
Copy link
Contributor Author

Running examples should be possible from any directory.

Be aware how data should be loaded ... see

https://github.com/sgeisler/termgraph/pull/13/files#diff-f3b336c79912a9e1cac25ea9647d6c520a273ac8c59986178391579c71bf3c3dR9-R10

@femtotrader
Copy link
Contributor Author

femtotrader commented Feb 7, 2021

PR #22 helps to be able to run examples directly from command line

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