https://github.com/bitranox/lib_csv
CSV Library
https://github.com/bitranox/lib_csv
Last synced: 9 months ago
JSON representation
CSV Library
- Host: GitHub
- URL: https://github.com/bitranox/lib_csv
- Owner: bitranox
- License: mit
- Created: 2020-05-06T16:09:44.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-24T23:22:44.000Z (over 1 year ago)
- Last Synced: 2025-03-01T11:21:01.202Z (over 1 year ago)
- Language: Python
- Size: 402 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
lib_csv
=======
|Pypi Status| |license| |maintenance|
|Build Status| |Codecov Status| |Better Code| |code climate| |code climate coverage| |snyk security|
.. |license| image:: https://img.shields.io/github/license/webcomics/pywine.svg
:target: http://en.wikipedia.org/wiki/MIT_License
.. |maintenance| image:: https://img.shields.io/maintenance/yes/2021.svg
.. |Build Status| image:: https://travis-ci.org/bitranox/lib_csv.svg?branch=master
:target: https://travis-ci.org/bitranox/lib_csv
.. for the pypi status link note the dashes, not the underscore !
.. |Pypi Status| image:: https://badge.fury.io/py/lib-csv.svg
:target: https://badge.fury.io/py/lib_csv
.. |Codecov Status| image:: https://codecov.io/gh/bitranox/lib_csv/branch/master/graph/badge.svg
:target: https://codecov.io/gh/bitranox/lib_csv
.. |Better Code| image:: https://bettercodehub.com/edge/badge/bitranox/lib_csv?branch=master
:target: https://bettercodehub.com/results/bitranox/lib_csv
.. |snyk security| image:: https://snyk.io/test/github/bitranox/lib_csv/badge.svg
:target: https://snyk.io/test/github/bitranox/lib_csv
.. |code climate| image:: https://api.codeclimate.com/v1/badges/7fa21a0ced3820c5faa9/maintainability
:target: https://codeclimate.com/github/bitranox/lib_csv/maintainability
:alt: Maintainability
.. |code climate coverage| image:: https://api.codeclimate.com/v1/badges/7fa21a0ced3820c5faa9/test_coverage
:target: https://codeclimate.com/github/bitranox/lib_csv/test_coverage
:alt: Code Coverage
functions to read and write csv files
automated tests, Travis Matrix, Documentation, Badges for this Project are managed with `lib_travis_template `_ - check it out
supports python 3.6-3.8, pypy3 and possibly other dialects.
`100% code coverage `_, mypy static type checking, tested under `Linux, macOS, Windows and Wine `_, automatic daily builds and monitoring
----
- `Installation and Upgrade`_
- `Usage`_
- `Usage from Commandline`_
- `Requirements`_
- `Acknowledgements`_
- `Contribute`_
- `Report Issues `_
- `Pull Request `_
- `Code of Conduct `_
- `License`_
- `Changelog`_
----
Installation and Upgrade
------------------------
Before You start, its highly recommended to update pip and setup tools:
.. code-block:: bash
python3 -m pip --upgrade pip
python3 -m pip --upgrade setuptools
python3 -m pip --upgrade wheel
install latest version with pip (recommended):
.. code-block:: bash
# upgrade all dependencies regardless of version number (PREFERRED)
python3 -m pip install --upgrade git+https://github.com/bitranox/lib_csv.git --upgrade-strategy eager
# test without installing (can be skipped)
python3 -m pip install git+https://github.com/bitranox/lib_csv.git --install-option test
# normal install
python3 -m pip install --upgrade git+https://github.com/bitranox/lib_csv.git
install latest pypi Release (if there is any):
.. code-block:: bash
# latest Release from pypi
python3 -m pip install --upgrade lib_csv
# test without installing (can be skipped)
python3 -m pip install lib_csv --install-option test
# normal install
python3 -m pip install --upgrade lib_csv
include it into Your requirements.txt:
.. code-block:: bash
# Insert following line in Your requirements.txt:
# for the latest Release on pypi (if any):
lib_csv
# for the latest Development Version :
lib_csv @ git+https://github.com/bitranox/lib_csv.git
# to install and upgrade all modules mentioned in requirements.txt:
python3 -m pip install --upgrade -r //requirements.txt
Install from source code:
.. code-block:: bash
# cd ~
$ git clone https://github.com/bitranox/lib_csv.git
$ cd lib_csv
# test without installing (can be skipped)
python3 setup.py test
# normal install
python3 setup.py install
via makefile:
if You are on linux, makefiles are a very convenient way to install. Here we can do much more, like installing virtual environment, clean caches and so on.
This is still in development and not recommended / working at the moment:
.. code-block:: shell
# from Your shell's homedirectory:
$ git clone https://github.com/bitranox/lib_csv.git
$ cd lib_csv
# to run the tests:
$ make test
# to install the package
$ make install
# to clean the package
$ make clean
# uninstall the package
$ make uninstall
Usage
-----------
.. code-block::
import the module and check the code - its easy and documented there, including doctest examples.
in case of any questions the usage section might be expanded at a later time
Usage from Commandline
------------------------
.. code-block:: bash
Usage:
lib_csv (-h | -v | -i)
Options:
-h, --help show help
-v, --version show version
-i, --info show Info
this module exposes no other useful functions to the commandline
Requirements
------------
following modules will be automatically installed :
.. code-block:: bash
## Project Requirements
docopt
Acknowledgements
----------------
- special thanks to "uncle bob" Robert C. Martin, especially for his books on "clean code" and "clean architecture"
Contribute
----------
I would love for you to fork and send me pull request for this project.
- `please Contribute `_
License
-------
This software is licensed under the `MIT license `_
---
Changelog
=========
0.1.0
-----
2020-05-27:
- new build matrix
- mypy strict type testing
- fix title in pypi documentation
- drop python2.7 - python 3.4 support
0.0.1
-----
2020-05-06:
- Initial public release