Skip to content

Commit

Permalink
add pypi release instructions in README (#15)
Browse files Browse the repository at this point in the history
* removed make release and updated readme file

* verifique la escritura de readme

* minor changes in README
  • Loading branch information
JessicaShalomG authored and matin committed Dec 21, 2018
1 parent 854878f commit b5f7de0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 12 deletions.
7 changes: 1 addition & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,4 @@ clean:
find . -name '*~' -exec rm -f {} +
rm -rf build dist clabe.egg-info

release: clean
python setup.py sdist bdist_wheel
twine upload dist/*


.PHONY: all install-dev release test clean-pyc
.PHONY: all install-dev release test clean-pyc
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
## CLABE
# CLABE

[![Build Status](https://travis-ci.com/cuenca-mx/clabe-python.svg?branch=master)](https://travis-ci.com/cuenca-mx/clabe-python)
[![PyPI](https://img.shields.io/pypi/v/clabe.svg)](https://pypi.org/project/clabe/)

Librería para validar y calcular un número CLABE basado en
https://es.wikipedia.org/wiki/CLABE

**Requerimientos**
## Requerimientos

Python v3 o superior.
Python 3.5 o superior.

**Instalación**
## Instalación

Se puede instalar desde Pypi usando

```
pip install clabe
```

**Test**
## Test

Para ejecutar los test utlizando el archivo Makefile

```
$ make test
```

**Uso básico**
## Uso básico

Obtener el dígito de control de un número CLABE

Expand Down Expand Up @@ -55,3 +55,12 @@ Para generar nuevo válido CLABES
import clabe
clabe.generate_new_clabes(10, '03218000011')
```

## Subir a PyPi

1. Actualizar version en `setup.py`
1. Commit cambios a `setup.py` y empujarlos a `origin/master`
1. `git tag -a <version> -m <release message>`
1. `git push origin --tags`

TravisCI subirá la version actualizada a PyPi despues de verificar que las pruebas pasen.

0 comments on commit b5f7de0

Please sign in to comment.