Contributing¶

Thank you for being interested in contributing to Skyport ! This document lists all the guidance you may need to contribute.

How does the project work?¶

Project structure¶

flowchart
    . --> docs
    . --> skyport
    . --> tests

The project is divided into three directories. docs, skyport and tests. Where each directory has its specific function.

skyport¶

flowchart
    . --> skyport
        skyport --> __init__.py
        skyport --> cli.py

All CLI code is written in the cli.py file. The docstrings follow the google docstring standard. So, if you change anything in the code, remember to also update the docstrings.

The CLI¶

The CLI was built using the Typer library, and you can check its documentation for more details if you want to expand the CLI's functionality.

For rich responses in the application output, the Rich library was used. If you want to change something in relation to the tables generated in the output, you can go directly to the documentation page for the tables.

The only convention that is being followed regarding the CLI is that a rich Console object has already been defined and a Typer app. It would be interesting for you to continue using these objects

skyport/cli.py

import typer
from rich.console import Console

...

app = typer.Typer(
    help='Skyport is a CLI for obtaining information from astronomical objects.'
)
console = Console()

Tests¶

For testing we are using pytest. Its settings can be found in the pyproject.toml file in the root of our project.

Test coverage is being generated automatically with pytest-cov and is displayed when the test task is executed:

$ task test

Just like linters are requirements for these tests.

Documentation¶

The entire documentation is based on the use of mkdocs with the mkdocs-material theme.

flowchart
    . --> docs
        docs --> css
        docs --> js
        docs --> templates
        docs --> tutorial
        docs --> contributing.md
        docs --> index.md
    . --> mkdocs.yml

All configuration can be found in the mkdocs.yml file in the root of the repository.

Various devices are also being used to complement the documentation. Like jinja templates in places where instructions can be repeated. If you find blocks like:

{ % % }

You will know that it is a template.

Templates are defined in the /docs/templates directory. In some cases, however, they may be called by variables with command.run which appears in almost all documentation files. These macros are being made with mkdocs-macros and are defined in the mkdocs configuration file:

mkdocs.yml

extra:
  commands:
    run: skyport

Tools¶

This project basically uses two tools as a basis for everything with control:

Poetry: For environment management and library installation;
Taskipy: For automation of routine tasks. How to run tests, linters, documentation, etc...

So, make sure you have poetry installed for this contribution:

$ pipx install poetry

Steps to perform specific tasks¶

Listed here are commands that you can use to perform common tasks. How to clone the repository, how to install the dependencies, run the tests, etc...

How to clone the repository¶

$ git clone https://github.com/henriquesebastiao/skyport.git

How to install dependencies¶

$ poetry install

How to run the CLI¶

$ task run [subcommand]

How to run code check¶

$ task lint

How to run the tests¶

$ task test

Tasks for contribution¶

These are tasks that we know need to be done to add new functionality to the CLI.

Currently, the focus is on implementing all public APIs made available by NASA, below is a list.

To implement:

I didn't find what I needed here¶

If you haven't found what you need, you can open an issue in the project reporting what you can't do or what needs to be better documented.

Continuous improvement¶

This document can be improved by anyone interested in improving it. So, feel free to provide more tips to people who want to contribute as well .