katolus/functions

A utility package for building, running and deploying serverless functions for the local and the cloud.

Hi there 👋. I'm Katolus.

I enjoy building tools to help me satisfy my curiosity 🌕 and experience 🌀.

I'm interested in Data and Machine Engineering, IoT devices and human behaviour.

Go-to stack involves:

• Python as the programming language of choice.
• GCP as a hosting platform of choice.
• VSCode as the editor.
• Ubuntu as the OS.

I'm currently 👷‍♂️ working on:

• Home Assistant setup for a local network.
• A Python package called functions that is built to interface with major FaaS offerings.

I'm currently 😑 researching:

• Open Source projects and communities.
• Computer Architecture, Internet Protocols and Encryption.
• Electrical Circuits and Material Science.
• Statistics.

You can 💬 ask me questions.

I would love to collaborate on projects resolving around health or physics.

You can reach me by writing me an 📫 email or LinkedIn message.

You can also visit my website for more information about projects, skills and not updated 👨‍💻 portfolio websites.

Have a good ... no have a great day 💙.

functions's Issues

Develop and an example on how trigger a `event` type locally

Organise types, validators and constants

The idea being of organising them in a way imports do not produce circular dependencies.

Add a `features` section or a document.

Store it is a part of the README file.

Add the ability to lunch other languages locally.

Add a wrapper around the base of the app

We need to add this scope to manage additional layers of the application.

The wrapper should handle any error falling under the registered errors, so a wrapper around the command and callback methods need to be added to avoid adding that in every bit of code.

Add a command to display the status of a given function

Add support for displaying a status of a function.

The status should work for any function within the repository of functions (logic to be created).

The information in there should present data like:

• Is it started/deployed?
• Maybe how long has it been running for?
• How to access it?

Write `config` command proposal

Add a proposal for adding the config command.

The command should include options of displaying the current configuration file and consider the possibility of disabling console colour enhancements.

Enhance `rebuild` method

• Make it work.
• [ ]

Add a `road map` document.

Add a document about:

• the direction and visions in which project might move in the future.
• ideas for features that would be great to implement like
  • add support for AWS
  • custom commands
    ...

Research best practices on enforcing type validation in custom error classes

The problem being.

• Should you even enforce anything?
• How do you validate that an error class is a valid error class?

Add a `rebuild` command that uses the configuration file to pick the function to be rebuild instead of the directory.

Enhance the `remove` command

• Add autocomplete to command invocation
• Catch exceptions on removing functions that don't exist
• Handle the case of removing the function when it is still running
• Make sure that the function removes all the resources and does not leave any artefacts

Each of these points can easily be an issue on its own.

Work on the core of the static types

Work through the most unchangeable and basic components of the package and start adding static types.

Best to start in LIFO merge reference.

Enhance `processes` module

• #89

Enhance `gcp` commands

• #111
• #112
• #113
• delete - add support for autocompletion from existing functions
• #114
• add autocomplete of the list of functions deployed
• #115
• #116

Add a version command

Add a command to display the current version of the package.

functions --version

Factor out docker specific logic outside of commands

Clean up logic in docker commands.
Move them into dedicated script.

Add an optional description to the config

Add the description to support additional information being displayed when managing the functions.

Add a `CODE_OF_CONDUCT` document

Trail the Golem in search for a possible match.

The Golem Network fosters a global group of creators building ambitious software solutions that will shape the technological landscape of future generations by accessing computing resources across the platform.

It would be good understand how it fits into this project and if it can be utilised to serve FaaS content.

Add an availability check on the `gcp` module

We want to ensure that the module is available to being used prior to making an calls.

Only enable gcp commands if the module is present.

Add `deprecated` and `development` decorators.

• add a deprecated decorator that would notify the user that a given functions is deprecated.
• add a development decorator that would only be available for usage in a development mode.

Enhance `list` method

• Add support for running and stopped.
• Maybe state like gcp-deployed would be a good idea.

Suggestions for states are also welcomed.

Create an entry documentation on `callbacks`

The information should include:

• the reason why you might need a callback.
• the cases in which you use callback vs the main function body.
• naming convention
• place to store

Add a command to cleanse all created docker resources

This is more of a development feature, but it would be great to be able to remove any package related resources to avoid polluting any of the existing docker scopes.

Considered options:

• using docker system prune with appropriate filters (on package labels)
• using relevant pruning options for containers and images separately

Configure PR template

Research the PR template documentation from Github:

• Read resource

Include information that is helpful to review a PR.

• Testing instructions
• Issue that the PR is fixing for automation
• Extra steps required

Plus anything that would be helpful when creating a comprehensive change requet.

Look into ways of enabling logging and basic history

To a trail/spike on how to enable this functionality. It is tied with the idea of adding a state to the functions.

Find a way to catch exceptions in callbacks

Fix the issue with the name being only alphabethic.

Find a better solution for LocalFunctionPath implementation

The implementation of that validation class was experimental. It has low readability and should be avoided.

Need to figure out a way of expressing the same restrains but provide readability in a context of a type.

Avoid mixing types with validations.

Add the ability to read (stream) a function's logs

Expose an additional command that would tail a log of a cloud function (specific to a cloud function for now).

Tackle `docker` module enhancements

• Enhance types
• Look into better options on creating a global object for the docker client.
• Add verbose logging to the workings of containers
• #134 - Moved out of the scope of this issue.
• Tackle all the TODO comments and items

- Add a function to retrieve a function config just from its name (Confirm). - Not idea what was this about.

Depends on #35.

Configure issue templates

Research the resources that Github has put on issues in order to understand what is available.

Create an issue template for

• new features
• enhancements
• bugs

Each of these should be independent and should hold a comprehensive but not overwhelming template of information.
Information like the package version, operating system, problem description etc...

Enhance `autocomplete` module

This is out is about enhancing the autocomplete module works by:

• Filter out functions that are already running.
• Find deployable functions, perhaps all the unctions that are present in the config?
• Update the complete services if still needed by code.

Add discussions to the repository

Create a comprehensive experience for the elusive community for potential contributions.

• Read the Discussions section in Github docs.
• Enable discussions for the project.

Add the ability to call the deployed cloud function and get the results in command line

gcloud functions call handler

Add `stubs` for the docker py library

We need to add the stubs to fully support model validation and typing for docker inherited instances.

Add a environment file to support having secrets locally

Address Deep source items.

Visit resources at https://deepsource.io/.

https://deepsource.io/docs/analyzer/python/#meta

Address all the minor changes that are spread through the codebase.

Remove all todo items from the codebase. Either:

• resolve
• create an issue
• remove

Enhance `run` command

Each of these should be a separate issue.

• Handle a case of running a function that does not exist/ has no image.
• Handle a case when a functions is already running.

Add basic documentation divided into usage and overview

As a result of this issue we want to have a good project overview with some basic examples on how to use it.

On top of that we would want to provide a additional expertise of the details of each command.

Store build functions in the config file

We would like to store information about a function in the config file to make it more available for quick use.

• #90
• #95
• #85

Write tests to support the core functions

Add tests and practices in place to support the core functions of the package:

• Run functions locally (start, stop, build).
• Deploy functions to the cloud (deploy, remove).

Add a config option for the package

We need to add a configuration folder that would allow to store the specifics of the package, storing info like the current region or existing functions being built.

Anything that would make sense. The poetry project is an interesting example and a base for this work.

https://python-poetry.org/docs/configuration/

Add `Contrubuting.md` document

Update the `build` command to display logs

Update the logs to use the `user` methods.

Deprecate the use of typer.echo in favour of methods that have logging implemented behind (from the functions/user module).

Enhance the support for tailored error handling

Create a registry of valid errors and allow for case to case error handling based on a command an expected errors.

Refactor `config` module

The principle of the effort being to make sure it is easy to understand and work one. Currently it is a bit of a mess.