goodlogistic

Repository for logistic solutions

https://github.com/rodrigosantosrodrigues/goodlogistic

Science Score: 31.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.5%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Repository for logistic solutions

Basic Info
  • Host: GitHub
  • Owner: RodrigoSantosRodrigues
  • License: mit
  • Language: HTML
  • Default Branch: main
  • Size: 3.28 MB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

Good logistic

Repository for logistic solutions

Toolkit for logistic problem, designed for real challenges organization.

Powered by daftar.digital

codecov

alt text

It provides:

Guide

start project

Prerequisites

Instalation dependency:

pip install -r requirements.txt

  1. Tests Execute tests:

python -m unittest discover tests

pytest --html=test-reports/report.html

  1. Publish in PyPI pip install twine wheel

Generate distribution: python setup.py sdist bdist_wheel

Publish in PyPI: twine upload dist/*

Commit Structure

A conventional commit typically follows the following structure:

  • Type: Indicates the nature of the commit. Common types include feat (for new features), fix (for bug fixes), docs (for documentation changes), style (for code style changes that do not affect behavior), refactor (for code refactoring), test (for adding or modifying tests), among others.

  • Scope (optional): Can be used to specify the part of the code being changed by the commit.

  • Description: A concise and clear description of what was changed in the commit.

Examples of Commit Messages

Here are some examples of commit messages following the Conventional Commits standard:

  • feat: Add support for OAuth authentication
  • fix: Fix logic error in tax calculation
  • docs: Update documentation for endpoint /api/users
  • style: Adjust indentation in views.py file
  • refactor: Extract email validation function to util.py
  • test: Add unit tests for login function

Benefits of the Conventional Commit Standard

  • Clarity: Facilitates quick understanding of changes introduced by each commit.
  • Automation: Automation tools such as changelog generators and continuous integration can use commit messages to automate tasks.
  • Clean History: Helps maintain a cleaner and organized commit history.

Supporting Tools

There are tools that help implement and maintain the Conventional Commits standard, such as commitizen and git-cz, which guide developers in creating commit messages in the correct format.

Following these guidelines not only improves team collaboration but also facilitates the maintenance and evolution of software projects over time.

Linter

Before commits and pushes pre-commit run --all-files

utils

https://peps.python.org/pep-0008/

VERSIONS

0.1.0

  • Description: Toolkit for logistic problem, designed for real challenges Nonprofit organization.
  • Author: contato@daftar.digital, contato@goodtruck.org.br
  • Published: Sat, 06 Jul 2024 20:26:26 GMT
  • Link: 0.1

  • Website: https://daftar.digital

  • Documentation: https://daftar.digital/doc

  • Source code: https://github.com/daftar/goodlogistic

  • Contributing: https://daftar/goodlogistic/dev/index.html

  • Bug reports: https://github.com/daftar/goodlogistic/issues

Owner

  • Name: Rodrigo Júnior
  • Login: RodrigoSantosRodrigues
  • Kind: user
  • Location: Belo Horizonte

Information Systems at Federal University of Viçosa. Python system engineer, javascript, and scientific researcher in computer vision. Development Analyst at D

Citation (CITATION.bib)

@ARTICLE{2020Chromotools,
  author  = {Rodrigo J. R Santos},
  title   = {Plataforma do Bem - Goodtruck.org.br},
  journal = {github},
  year    = {2024},
  volume  = {},
  pages   = {},
  doi     = {}
}

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Dependencies

.github/workflows/codecov.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v4.0.1 composite
.github/workflows/publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/test.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
Pipfile pypi
pyproject.toml pypi
requirements.txt pypi
  • Jinja2 ==3.1.4
  • MarkupSafe ==2.1.5
  • PyYAML ==6.0.1
  • Pygments ==2.18.0
  • SecretStorage ==3.3.3
  • backports.tarfile ==1.2.0
  • black ==24.4.2
  • certifi ==2024.7.4
  • cffi ==1.16.0
  • cfgv ==3.4.0
  • charset-normalizer ==3.3.2
  • click ==8.1.7
  • coverage ==7.5.4
  • cryptography ==42.0.8
  • distlib ==0.3.8
  • docutils ==0.20.1
  • exceptiongroup ==1.2.1
  • filelock ==3.15.4
  • flake8 ==7.1.0
  • identify ==2.5.36
  • idna ==3.7
  • importlib_metadata ==8.0.0
  • iniconfig ==2.0.0
  • jaraco.classes ==3.4.0
  • jaraco.context ==5.3.0
  • jaraco.functools ==4.0.1
  • jeepney ==0.8.0
  • keyring ==25.2.1
  • markdown-it-py ==3.0.0
  • mccabe ==0.7.0
  • mdurl ==0.1.2
  • more-itertools ==10.3.0
  • mypy-extensions ==1.0.0
  • nh3 ==0.2.17
  • nodeenv ==1.9.1
  • packaging ==24.1
  • pathspec ==0.12.1
  • pkginfo ==1.10.0
  • platformdirs ==4.2.2
  • pluggy ==1.5.0
  • pre-commit ==2.20.0
  • pycodestyle ==2.12.0
  • pycparser ==2.22
  • pyflakes ==3.2.0
  • pytest ==8.2.2
  • pytest-cov ==5.0.0
  • pytest-html ==4.1.1
  • pytest-metadata ==3.1.1
  • readme_renderer ==43.0
  • requests ==2.32.3
  • requests-toolbelt ==1.0.0
  • rfc3986 ==2.0.0
  • rich ==13.7.1
  • tomli ==2.0.1
  • twine ==5.1.1
  • typing_extensions ==4.12.2
  • urllib3 ==2.2.2
  • virtualenv ==20.26.3
  • zipp ==3.19.2
setup.py pypi