fz0x1/HPI
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix demo, update readme

Browse source
This commit is contained in:
Dima Gerasimov 2019-11-15 08:17:44 +00:00
parent db3d4ed97b
commit d0b787c4c2
3 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.org
View file

@ -1,11 +1,13 @@
[[https://circleci.com/gh/karlicoss/my/tree/master][https://circleci.com/gh/karlicoss/my/tree/master.svg?style=svg]]
Python interface into my life.
Python interface into my life and data.
This package deals with abstracting away various data sources and providing nice Python interface for them, also lets you define covenience functions.
This package deals with abstracting away various data sources and providing nice Python interfaces for them, to make it easier to access, work with and combine data.
This might not necessarily be convenient for you to use, perhaps it's more of a concept of how you can organize and access your personal data.
But it works for me so hopefully that would help you if you're struggling!
This particular setup might not necessarily be convenient for you to use, perhaps it's more of a concept of how you can organize and access your personal data.
But it definitely works for me so hopefully that would help you if you're struggling!
This readme is more of a setup manual, I'm writing about motivation and specific usecases [[https://beepb00p.xyz/mypkg.html][here]].
* Setting up
** =my_configuration= package for private paths/repositores (optional)
@ -66,7 +68,7 @@ It's also convenient to put =with_my= somewhere in your system path so you can r
** Dependencies
Dependencies are different for specific modules you're planning to use, so it's hard to specify.
Generally you can just try and then install missing packages via ~pip install --user~, should be fairly straighforward.
Generally you can just try using the module and then install missing packages via ~pip install --user~, should be fairly straighforward.
* Usage examples
If you run your script with ~with_my~ wrapper, you'd have ~my~ in ~PYTHONPATH~ which gives you access to your data from within the script.

2
demo.py
View file

@ -51,7 +51,7 @@ from pprint import pprint
for page in my.hypothesis.get_pages()[:8]:
print('URL: ' + page.link)
print('Title: ' + page.title)
print('{} annotations'.format(len(page.annotations)))
print('{} annotations'.format(len(page.highlights)))
print()
'''])

6
my_configuration_template/my_configuration/__init__.py
View file

@ -1,6 +1,6 @@
class paths:
"""
Feel free to remore hypexport if you don't need it/add your own custom settings and use them
Feel free to remove this if you don't need it/add your own custom settings and use them
"""
class hypexport:
export_dir = '/tmp/my_demo/backups/hypothesis'
class hypothesis:
export_path = '/tmp/my_demo/backups/hypothesis'