Metadata-Version: 2.1
Name: countries-utils
Version: 1.0.21
Summary: Utils to deal with pycountry and country_list packages
Home-page: https://bitbucket.org/altf1be/countries_utils.git
Author: Abdelkrim Boujraf
Author-email: abo+countries_utils_pkg@alt-f1.be
License: European Union Public Licence 1.2 (EUPL 1.2)
Project-URL: Bug Reports, https://bitbucket.org/altf1be/countries-utils/issues?status=new&status=open
Project-URL: Company behind the library, http://www.alt-f1.be
Project-URL: Source, https://bitbucket.org/altf1be/countries-utils
Description: # countries-utils
        
        Utils used by the dunning service wrapper. See <https://bitbucket.org/altf1be/countries-utils>
        
        * Get the list of countries stored in the field "place" in transactions stored in twikey.
        * The places are written either in FR, EN or NL.
        * The method returns a List of places in English and a Set of those places if the places are using the above-mentioned languages
        
        ## usage
        
        * install the package from the **pypi.org** : 
            * install : `pip install countries-utils`
            * upgrade : `pip install countries-utils --upgrade`
        
        
        * install the package from the **test.pypi.org** : 
            * install : `pip install -i https://test.pypi.org/simple/ countries-utils`
            * upgrade : `pip install -i https://test.pypi.org/simple/ countries-utils --upgrade`
        
        ## dependencies
        
        * pycountry : <https://pypi.org/project/pycountry>
        * country_list : <https://pypi.org/project/country_list>
        
        ## Build the package 
        
        * build the setup.py
            * `python setup.py sdist bdist_wheel`
        
        * upload the library on TEST **pypi.org** 
            * `python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*` 
            * Source : <https://test.pypi.org/project/countries-utils>
        
        * upload the library on PROD **pypi.org** 
            * `python -m twine upload dist/*` 
            * Source : <https://pypi.org/project/countries-utils>
        
        
        ## test the library
        
        * `cd countries_list`
        * `pipenv run python countries_utils_unittest.py`
        
        * locate the package 
            * `python -c "import countries_utils as _; print(_.__path__)"`
        * list functions inside the module
            *  the package `python -c "import countries_utils as _; print(dir(_))"`
        
        * test the package 
            * `python -c "import countries_utils, pandas as pd, numpy as np; print(countries_utils.get_list_of_countries_in_text(
                    pd.DataFrame(np.array(['Belgium', 'Frankrijk', 'Royaume-Uni']), columns=['place']),
                    place='place',
                    languages_to_check=['en', 'fr', 'nl']
                    )
                )"`
            * result : `(['Belgium', 'France', 'United Kingdom'], {'United Kingdom', 'France', 'Belgium'})`
        
        ## Documentation
        
        * Packaging Python Projects <https://packaging.python.org/tutorials/packaging-projects/>
        * Managing Application Dependencies <https://packaging.python.org/tutorials/managing-dependencies/#managing-dependencies>
        * Packaging and distributing projects <https://packaging.python.org/guides/distributing-packages-using-setuptools/#distributing-packages>
        
        ## License
        
        Copyright (c) ALT-F1 SPRL, Abdelkrim Boujraf. All rights reserved.
        
        Licensed under the EUPL License, Version 1.2.
        
        See LICENSE in the project root for license information.
        
Keywords: library,pycountry,country_list,dunning_service,alt-f1.be
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.5
Description-Content-Type: text/markdown
