Metadata-Version: 2.1
Name: atnlp
Version: 0.0.9
Summary: A tool for natural language processing in python based on scipy and sklearn
Home-page: https://github.com/wedavey/atnlp
Author: Will Davey
Author-email: wedavey@gmail.com
License: MIT
Description: # atnlp
        
        
        A tool for natural language processing in python based on scipy and sklearn. 
        
        Current focus is topic labelling. [Read the docs](https://wedavey.github.io/atnlp/) for more information.
        
        ## Technologies
        
        atnlp uses the following technologies: 
        
        - [conda](https://www.anaconda.com/) - datascience platform 
        - [scipy](https://www.scipy.org/) - datascience tools
        - [sphinx](http://www.sphinx-doc.org/en/master/) - documentaion
        - [bumpversion](https://github.com/peritus/bumpversion) - semantic versioning 
        - [github](https://github.com/) - software development platform 
        - [travis](https://travis-ci.org/wedavey/atnlp) - continuous integration 
         
        
        
        ## Quick start
        More details in [quickstart docs](https://wedavey.github.io/atnlp/quickstart.html)
        
        ### Prerequisites 
        
        - **conda** (anaconda / miniconda) - follow the 
        [installation instructions](https://conda.io/docs/user-guide/install/index.html) 
        for your platform and select python 3 version.
        
        After installing update `conda` from the `conda-forge` repo: 
        ```
        conda update conda -c conda-forge 
        ```
        
        
        ### Install (production)
         
        Install atnlp (with pip) and its dependencies (with conda): 
        ```bash
        wget https://raw.githubusercontent.com/wedavey/atnlp/master/envprod.yml
        conda env create -f envprod.yml -n atnlp
        conda activate atnlp
        ```
        
        ### Install (development) 
        
        Fork [wedave/atnlp](https://github.com/wedavey/atnlp) then install 
        from github:
        ```bash
        git clone git@github.com:<your-user-name>/atnlp.git
        conda env create -f atnlp/envdev.yml -n atnlp-dev
        conda activate atnlp-dev
        cd atnlp; python setup.py develop
        ```
        
        
        
        ## Running tests
        
        TODO...
        
        
        ## Deployment 
        
        Start [training topic models](https://wedavey.github.io/atnlp/topiclabel.html) 
        straight away using scripts, or open a notebook and start hacking.
        
        
        ## Versioning
        
        We use [SemVer](https://semver.org/) for versioning, implemented through bumpversion. 
        For the versions available, see the [tags on this repository](https://github.com/wedavey/atnlp/tags). 
        
        ## Authors
        
        - **Will Davey** - main developer
        
        ## License
        
        This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: deep
Provides-Extra: docs
Provides-Extra: extras
Provides-Extra: book
