Metadata-Version: 2.1
Name: xsthunder-python-lib
Version: 0.0.2
Summary: personal lib
Home-page: https://github.com/xsthunder/xsthunder_python_lib
Author: xsthunder
Author-email: xsthunder@outlook.com
License: UNKNOWN
Description: personal python lib [![Build Status](https://travis-ci.com/xsthunder/python-lib.svg?branch=master)](https://travis-ci.com/xsthunder/python-lib)
        ------
        legacy python lib see [xsthunder/python-lib-old: useful python pieces of code](https://github.com/xsthunder/python-lib-old)
        
        ### TODO
        
        1. - [x] fix three version replicates, in `rebuild.cmd`, `x_lib.__init__`, `setup.py`
        2. - [x] create github repo
        3. - [x] ex_command能用，默认目录就在jupyter目录下。即外部可以直接使用x_lib.common.ex_command
        1. - [x] save_and_export_notebook使用了`./`就是本目录下要求一定有script；；解决方法是通过import而不是ex_command的方式保存文件
        1. - [x] save_and_export_notebook使用了支持多级目录
         
        ### Features
        
        1. Full test with traivis to make sure things are on rail.
        2. list of function see [doc](./doc/README.md)
        
        ## Install and Run
        
        ### Install via pip
        
        1. `pip install xsthunder-python-lib` or `xsthunder-python-lib --user`
        
        ### Use in Code
        
        #### use for single `ipynb` file
        
        export the `ipynb` file
        
        ```python
        nbe = common.NBExporter()
        nbe('./pdb.ipynb', to='./')
        ```
        #### use for projcet
        
        clone [xsthunder/jupyter_dev_template](https://github.com/xsthunder/jupyter_dev_template)
        
        ## Development
        
        ### Environment Setup
        
        [for conda](./config/create-env.sh)
        
        ### deps
        
        1. not all [deps](./config/create-env.sh) are necessary. only ipython are set in the `setup.py/deps`.
        2. `x_lib.common` supports dynamic import. feel free to import.
        3. to import other modules, please install corresponding deps first or you may come across error.
        4. It's recommanded to install all packages listed in [create-env.sh](./config/create-env.sh)
        
        #### Ref 
        
        [deployment - How can I use setuptools to generate a console_scripts entry point which calls `python -m mypackage`? - Stack Overflow](https://stackoverflow.com/questions/27784271/how-can-i-use-setuptools-to-generate-a-console-scripts-entry-point-which-calls)
        
        [Packaging Python Projects — Python Packaging User Guide](http://packaging.python.org/tutorials/packaging-projects/)
        
        `notebook2script` from [course-v3/nbs/dl2 at master · fastai/course-v3](https://github.com/fastai/course-v3/tree/master/nbs/dl2)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.4
Description-Content-Type: text/markdown
