pedro/go-blocks
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme and add license

Browse Source
This commit is contained in:
Pedro Pérez 2024-11-25 12:29:32 +01:00
parent 198bceb9ba
commit 343d4893f0
2 changed files with 32 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 Pedro Pérez Banda
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

27
README.md
View File

@ -1,19 +1,16 @@
# Gopher Toolbox
Es una librería donde se concentra el código _boilerplate_ que se usan en
distintos proyectos. Incluyen lo siguiente:
It is a library that gathers the boilerplate code used in different projects.
It includes the following:
- Implementación controladores de bases de datos:
- Database controller implementations:
- [PGX Pool](github.com/jackc/pgx/v5)
- MySQL
- Utilities for converting [pgtype](github.com/jackc/pgx/v5/pgtype) to Go types.
- Utilidades para conversión de tipos [pgtype](github.com/jackc/pgx/v5/pgtype) a
tipos de Golang.
- Generación de datos aleatorios para pruebas unitarias, similar a librería
[Faker](https://faker.readthedocs.io/en/master/) de Python.
- Random data generation for unit tests, similar to the [Faker](https://faker.readthedocs.io/en/master/)
in Python.
```go
MaleName() string
@ -32,15 +29,13 @@ NumericString(length int) string
Sentence(min, max int) string
```
- Conversión de ficheros Excel a tipos estructurados. Se le pasa el tipo del
_struct_ a la función `Convert[T any](bookPath, sheetName string)` y te
devolverá los datos del tipo `dataExcel []T`.
- Conversion of Excel files to structured types. You pass the struct type to the
function `Convert[T any](bookPath, sheetName string)`, and it will return the
data as `dataExcel []T`.
- Constants for HTTP handlers.
- Constantes para los manejadores HTTP.
- Utilidades varias
- Miscelaneous utilities
```go
CorrectTimezone(timeStamp time.Time) time.Time