hectorcanto

A list of software engineering vocabulary in English, Spanish, and Portuguese as I found them in my day to day

hectorcanto

"""This is the docstring main line, I prefere them without a final dot

Descritption goes after a brealine, first line should not be multiline but second can be.
After it there can be many section like: Example, Usage, Returns, Attributes, Todo ... There 
might special notation for documentation tooling like Sphinx or Handsdown. In general avoid

Avoid `Attributes` and `Returns` typing if specified in the hinting unless it is necessary for the tooling.

This is based in: [Sphinx Napoleon](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)

hectorcanto

Overview

This is a list of shareable things under my GitHub account, being that gists or full repos

Templates

• Python template(s): to be published
• Python lib template: to be published
• Readme template
• Pytest training (several repos), to be linked

hectorcanto

#!/usr/bin/env bash

# SYNTAX branchtype/[subproject/]description_with_underscore-#CODE-123
# Example feature/main_api/new_feature-#MAPI-123

# Separators: slash (/) dash (-), don't use dashes as spaces, please

# Why this syntax?
# ticket at the end to keep autocomplete working in terminal
# optional subproject for better CI pipeline decissions per subproject (multirepo, subapps, contexts ..)

hectorcanto

Keybase proof

I hereby claim:

• I am hectorcanto on github.
• I am hcanto_cin (https://keybase.io/hcanto_cin) on keybase.
• I have a public key ASDJSGfwdj2HKLYnaKBFpNG9G72qZC_HfltgDs1901IsrAo

To claim this, I am signing this object:

hectorcanto

def pytest_collection_modifyitems(items):
    """
    Add marker to all tests in the conftest folder tree.
    
    You need to organize your tests in folders for it to work.
    
    Usage: `pytest -m $marker_expression`
    Example: `pytest -m unit1
    
    Reference: https://docs.pytest.org/en/stable/reference.html?highlight=collection_modi#pytest.hookspec.pytest_collection_modifyitems

hectorcanto

# https://misc.flogisoft.com/bash/tip_colors_and_formatting
RED="\\e[91m"
GREEN="\\e[32m"
BLUE="\\e[94m"
YELLOW="\\e[33m"
REGULAR="\\e[39m"

REPORTS=".coverage-reports"
SRC="app"
VERSION=$(shell cat ${SRC}/__init__.py | head -n 1 | cut -d" " -f 3 | tr -d "'")

hectorcanto

app: for application, many things are considered an application. Use adjectives like web_app, phone_app, django_app
api: application programming interface (any communication protocol may be labelled an API, user rest_api when possible)
rel: relation or relative?
srv: server or service?

hectorcanto

ADR Template

Short Title

Short title of solved problem and solution [Describe the general problem and the chosen solution in free from in a few sentences. Leave specific details for the following sections]

hectorcanto

# Get all indices, verbose
GET /_cat/indices?v

# Create an index with a mapping
PUT index
{
  "mappings": {
    "_doc": { 
        "properties": {
          "field": {