Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aliartiza75/python-list-comparison

A python module to compare two lists that have complex data in it like list, dictionary etc
https://github.com/aliartiza75/python-list-comparison

listcomparision python-list python2 python3 pythonlist pythonmodule

Last synced: 2 months ago
JSON representation

A python module to compare two lists that have complex data in it like list, dictionary etc

Awesome Lists containing this project

README

        

[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/dashboard?id=aliartiza75_python-list-comparison)
[![CircleCI](https://circleci.com/gh/aliartiza75/python-list-comparison.svg?style=svg)](https://circleci.com/gh/aliartiza75/python-list-comparison)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=aliartiza75_python-list-comparison&metric=bugs)](https://sonarcloud.io/dashboard?id=aliartiza75_python-list-comparison)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=aliartiza75_python-list-comparison&metric=ncloc)](https://sonarcloud.io/dashboard?id=aliartiza75_python-list-comparison)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=aliartiza75_python-list-comparison&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=aliartiza75_python-list-comparison)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=aliartiza75_python-list-comparison&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=aliartiza75_python-list-comparison)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=aliartiza75_python-list-comparison&metric=security_rating)](https://sonarcloud.io/dashboard?id=aliartiza75_python-list-comparison)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=aliartiza75_python-list-comparison&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=aliartiza75_python-list-comparison)
# pylistcompare

A module to compare two lists that complex data in it.

# Installation guidelines

* Install the module
```bash
$ pip3 install listcompare
```
OR

```bash
$ pip install listcompare
```

## Usage guidelines

Import the module in your file or ipython3 shell

```bash
$ import listcompare

$ lis1 = [1, 2, 3]
$ lis2 = [2, 1, 3]

$ listcompare.compare_list(lis1, lis2)
$[output] True

$ lis1 = [1, 2, "3"]
$ lis2 = [2, 1, 3]

$ listcompare.compare_list(lis1, lis2)
$[output] False

```

## Project dependencies installation guidelines

Run this command to install the dependencies
```bash
$ sudo pip3 install -r requirements.txt
```

## Project distribution pusblishing guidelines

* Update the setup.py file in the root directory.
* To create source distribution run the command given below:
```bash
$ python3 setup.py sdist
```
* I will use [twine](https://pypi.org/project/twine/) to publish my package distribution
```bash
$ pip3 install twine
$ sudo twine upload dist/* # it will ask for username and password
```
Sometime twine can publish the distribution because of authentication issue but mostly works on 2nd or 3rd retry.

## Guidelines for cythonizing the project
```bash
$ cd listcompare
$ python setup.py build_ext --inplace
```

## Project distribution page of pypi

Link to the pypi module [page](https://pypi.org/project/listcompare/)
Link to module webpage [page](https://aliartiza75.github.io/python-list-comparison/)