Skip to content

Commit

Permalink
[SPP] Completed basic setup package and CI integration.
Browse files Browse the repository at this point in the history
  • Loading branch information
LucaCappelletti94 committed Feb 26, 2020
1 parent 635cd86 commit 5261712
Show file tree
Hide file tree
Showing 6 changed files with 137 additions and 18 deletions.
22 changes: 7 additions & 15 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
\.vscode/

\.DS_Store

__pycache__

*/__pycache__/*

**/__pycache__/*

.notipy.json

.single_run

*/__pycache__/*
coverage.xml
__pycache__
.coverage*

coverage.xml
\.DS_Store
.single_run
\.vscode/
.notipy.json
2 changes: 1 addition & 1 deletion .spp_cache/badges.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"code_climate": {"code_climate_maintainability_url": "https://api.codeclimate.com/v1/badges/1e95e0c5b6331cbf85aa/maintainability", "code_climate_coverage_url": "https://api.codeclimate.com/v1/badges/1e95e0c5b6331cbf85aa/test_coverage"}}
{"code_climate": {"code_climate_maintainability_url": "https://api.codeclimate.com/v1/badges/1e95e0c5b6331cbf85aa/maintainability", "code_climate_coverage_url": "https://api.codeclimate.com/v1/badges/1e95e0c5b6331cbf85aa/test_coverage"}, "codacy": {"codacy": "image:: https://api.codacy.com/project/badge/Grade/0968ff39b133475da3a9c528b8ae2c9d\n :target: https://www.codacy.com/manual/LucaCappelletti94/csv_trimming?utm_source=github.com&utm_medium=referral&utm_content=LucaCappelletti94/csv_trimming&utm_campaign=Badge_Grade"}}
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@ env:
global:
- secure: Jk7tcCKmZAWPj8XVDUoJvcG4Xr9ZMKpvxWifSvMhmOOEZzvtHVJrnG2y3sp/z9HQYtqMkPflH/NTElrYtNB/0XSuBjWUcvvvC33Z842jJVJziDeD1tWbijkNM0U/Pf8r4E5aW1DnsGtM8lcd5L2DQdyWDZEJsBXzsfXO+X3agqTxfUzrQroAO/cL/jcUVeHLeYn4WP7SVkeEMp3mMchd5ixNTdgRuq7zi6QQS8TFCnHg9pdH0C50JFTpUcCN1vCeyDD0UARacZXQkbWJaFOzkof481tyXw3392Cb7g5LnI8ss4GWWmjm/moebv822h4N5FrmDkXzB5KRyw1Tetuk7bqYOX2QcW2LC2U4oBcujtThxAjWr9j3Axr/HOiPfrjzRFxM13H4/e0bcyUldfwEhfphP5lTuKLaQzk5Gwo5s6O6zx8LEJlnurTfqPOXSHAnmItMKwzveqyH/r5vkzBksSf5dH1A6lOoXgoD3/jcL2FZEqooFlCd7+cKrzIR02UqfVAruIjIAeZTgLUWTkEWWAT+gaTQq9wHMsVJ1OtUtIz2Tc9EzHG6EoeE4+IEWXhwFaYV8hbeukerxINV3rBCe4niEUx3D/Dt7j3MAGywCcUwwT/sbQiucNpB2phPofJHenLYH0sjLpbS0PBNj5ASTW+DeLFG1f1YnPPcOFl40uw=
- secure: vmiBQd2LIyda72qCTzCu6NgaqGIdWUuT1Qty+qhneZcf57N9p0vdJwz1dpTmvsyzSl6OB5QgG9kiL2lJBq3XXDtyTwQIGFYBUU9++x80TN+1KulxTu/+CORzOQ6ndz2MtA9S+SARkb/+Zo5IqG5i27I2qIZgVu3GaYI2I9VRXyfM9SnJ9nUoBMciMx9rIAGBlGspkSE2gY5Ml2yrkwR58x0uWtD14e85bQD2Wj529O7bFYyWtKxI5FKSNKKQJQG6ug1e4Fx5XuDfgAE+PWiGjFymuN7zcGkO1hi1J4mTo2+tllSJb/elP/fA42mPRLOjiefgaAErT+XCjJJP/0e/5pRUDsyvBiTVRf3ZgB66MSk8nqIeVLVXF0AGM15Gc6JrifIZ8sVhi49XYFnQOF3MX01s4CNPh5/qPtmtyOLA2JlALlcF+jH0hDjHpLne4HXm4g3N5Nbsx5oFRxifkaX/AUaosxbFjJJS+yjA+lzGm4g3D8Tyt1GR7ttIroBvbzgMonol3TrENzDEI5f7mbE09ulZHBJGp775qhXcfXexYezsISubaFt1Y5i3winiNF9DRLOMSO0LBUqjeoij4Ozlsrp8cEonoXgMW+FOmTGNUBIsvg+m5jwtGaKb5EWJvUtThplFenIakueD0ka/MQkigThhExKlw/AH9W/8lRo1bQU=
- secure: BLY7wGvbUbHXc7+av2yKnZXqMZI7vgA+ju+0u8Duh7ttv3E656PEs5iw+RzGp+LZHJmxqguL0sPk+7CXJTNdRchTF7Pm+6sb0sVnr5ir9T01CKRDaWzvnvFzS5japjr/PKUmLyZxQuRuapXr1NoGQHWNItmk6uznYvwaLR4KQqUNL8ExlqgxLEGj3RAFJ+itGKvmKz6xK0FENwOhbrNOjTxli9OUiHU3+vpyF+xFRVvGsnx4HTLH/7VoQ5nCKWzOSJOscHY4AJdYCdLPrvZddjwx2TmafBeJt27ED915Aqu74HnSqI+8bvf0GsrAzzIyW46u32OgJZ53b04d02B9H1xQZZk4kKWcnb+H45VM61tmeqRgMORlxOeXoFAlY5nAJyMI9hOPCvUD9e3b6zsBehUvV6k+b2MMIUnKz/2R2upCZZio0CS6r5bbSH6dbqV/O58gLPQJ3jvQvmxoK/O59M8V4qxtGuHDQltUORElW5qoSO4jdHnZO4ssQ3Igxe7DWRtfSK9bThfrBWo7hfxncgYVN761S1SxkWZtNJK0u0jEjsKviL+tmcWvzCB5tOeNW19H7CLwoLMbTx1qG7ORI9GM05hU6/Y5WaXd8wDHqJ1R1+uXsrxv/ChvYdQi8J+3NENtCYMuVIH6q9Z2fsESn1cNgSqSXQCxDMphpxAA5EA=
2 changes: 0 additions & 2 deletions README.md

This file was deleted.

64 changes: 64 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
csv_trimming
=========================================================================================
|travis| |sonar_quality| |sonar_maintainability| |codacy|
|code_climate_maintainability| |pip| |downloads|

Package python to remove common ugliness from a csv-like file

How do I install this package?
----------------------------------------------
As usual, just download it using pip:

.. code:: shell
pip install csv_trimming
Tests Coverage
----------------------------------------------
Since some software handling coverages sometime
get slightly different results, here's three of them:

|coveralls| |sonar_coverage| |code_climate_coverage|

Package python to remove common ugliness from a csv-like file


.. |travis| image:: https://travis-ci.org/LucaCappelletti94/csv_trimming.png
:target: https://travis-ci.org/LucaCappelletti94/csv_trimming
:alt: Travis CI build

.. |sonar_quality| image:: https://sonarcloud.io/api/project_badges/measure?project=LucaCappelletti94_csv_trimming&metric=alert_status
:target: https://sonarcloud.io/dashboard/index/LucaCappelletti94_csv_trimming
:alt: SonarCloud Quality

.. |sonar_maintainability| image:: https://sonarcloud.io/api/project_badges/measure?project=LucaCappelletti94_csv_trimming&metric=sqale_rating
:target: https://sonarcloud.io/dashboard/index/LucaCappelletti94_csv_trimming
:alt: SonarCloud Maintainability

.. |sonar_coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=LucaCappelletti94_csv_trimming&metric=coverage
:target: https://sonarcloud.io/dashboard/index/LucaCappelletti94_csv_trimming
:alt: SonarCloud Coverage

.. |coveralls| image:: https://coveralls.io/repos/github/LucaCappelletti94/csv_trimming/badge.svg?branch=master
:target: https://coveralls.io/github/LucaCappelletti94/csv_trimming?branch=master
:alt: Coveralls Coverage

.. |pip| image:: https://badge.fury.io/py/csv_trimming.svg
:target: https://badge.fury.io/py/csv_trimming
:alt: Pypi project

.. |downloads| image:: https://pepy.tech/badge/csv_trimming
:target: https://pepy.tech/badge/csv_trimming
:alt: Pypi total project downloads

.. |codacy| image:: https://api.codacy.com/project/badge/Grade/0968ff39b133475da3a9c528b8ae2c9d
:target: https://www.codacy.com/manual/LucaCappelletti94/csv_trimming?utm_source=github.com&utm_medium=referral&utm_content=LucaCappelletti94/csv_trimming&utm_campaign=Badge_Grade
:alt: Codacy Maintainability

.. |code_climate_maintainability| image:: https://api.codeclimate.com/v1/badges/1e95e0c5b6331cbf85aa/maintainability
:target: https://codeclimate.com/github/LucaCappelletti94/csv_trimming/maintainability
:alt: Maintainability

.. |code_climate_coverage| image:: https://api.codeclimate.com/v1/badges/1e95e0c5b6331cbf85aa/test_coverage
:target: https://codeclimate.com/github/LucaCappelletti94/csv_trimming/test_coverage
:alt: Code Climate Coverate
64 changes: 64 additions & 0 deletions suggested_setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
import os
import re
# To use a consistent encoding
from codecs import open as copen

from setuptools import find_packages, setup

here = os.path.abspath(os.path.dirname(__file__))

# Get the long description from the relevant file
with copen(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()


def read(*parts):
with copen(os.path.join(here, *parts), 'r') as fp:
return fp.read()


def find_version(*file_paths):
version_file = read(*file_paths)
version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
version_file, re.M)
if version_match:
return version_match.group(1)
raise RuntimeError("Unable to find version string.")


__version__ = find_version("csv_trimming", "__version__.py")

test_deps =[
"coveralls",
"validate_version_code",
"codacy-coverage",
"pytest-cov",
"pytest"
]

extras = {
'test': test_deps,
}

setup(
name='csv_trimming',
version=__version__,
description="Package python to remove common ugliness from a csv-like file",
long_description=long_description,
url="https://github.com/LucaCappelletti94/csv_trimming",
author="LucaCappelletti94",
author_email="cappelletti.luca94@gmail.com",
# Choose your license
license='MIT',
include_package_data=True,
classifiers=[
'Development Status :: 3 - Alpha',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3'
],
packages=find_packages(exclude=['contrib', 'docs', 'tests*']),
tests_require=test_deps,
# Add here the package dependencies
install_requires=[],
extras_require=extras,
)

0 comments on commit 5261712

Please sign in to comment.