Setting up my first OpenSource Python project

In this series, I will explain what I did to set-up my first PyPi project. It’s a bit of a double whammy, it should help people sorting that out, and check with other developer what I did oddly.

This is also my first python project of my own. I have learned lots but I understand there is plenty of room for error and improvements (hopefully more of the later)

I will start by explaining the project itself, and the reason for it. You should not need to know it, but it should allow to understand the reasons behind it.

The project is logger-to-kibana and encapsulates the main idea of trying to automate everything.

It will be too long for a single post so I decided to make it a series.

It also allows me time to continue improving the process and adding extra functionalities to logger-to-kibana project.

I hope this helps and encourage people to set-up Open Source projects that solves those annoying repetitive tasks.

As always, I welcome constructive feedback. This is also my first dev post and most of the tools used are new to me. That is one of the reasons to play with them ;) 

Let me know what you think about it. Lets get started with the project itself.

Automating Kibana Visualisations Generation

IsmaelMartinez ・ Nov 28 '19

#opensource #logs #automation #kibana

---

You can also pop along and help contribute into the project. ;)

IsmaelMartinez / logger-to-kibana

Parse loggers in your code and generate a kibana visualisation with them

logger-to-kibana

---

This project is inteded to generate view from the log messages encountered.

The python executable can be found in https://pypi.org/project/logger-to-kibana/

You will need to install the dependences by running

pip install -r requirements.txt

To get the programs help just type:

python main.py

This returns:

  Usage: main.py [OPTIONS] COMMAND [ARGS]...

  Process the file provided according to conditions

Options:
  --help  Show this message and exit.

Commands:
  pommands:
  process                    Process the folder
  process_and_generate       Process the folder and generate visualization
  process_generate_and_send  Process the folder, generate visualization and
                             send

I have created a dev.to series explaining how this project works and any learning that I have taken from doing so. You can find it in https://dev.to/ismaelmartinez/setting-up-my-first-opensource-python-project-4k1o

Default settings

The default settings can be found in the settings.ini file. You can provide a different settings file by specifying it as an environment variable LOGGER_TO_KIBANA_CONFIG

commands

The current available commands are:

process

Process a folder and…

View on GitHub