mkdir -p assets
Save the logo as loglama-logo.svg
Some badges require additional setup to work properly:
Create .github/workflows/ci.yml:
name: CI
on:
push:
branches: [ main, develop ]
pull_request:
branches: [ main ]
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.10, 3.11, 3.12]
steps:
- uses: actions/checkout@v4
- name: Set up Python $
uses: actions/setup-python@v4
with:
python-version: $
- name: Install dependencies
run: |
make setup
- name: Run tests
run: |
make test
- name: Run linting
run: |
make lint
Add to your CI workflow:
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
file: ./coverage.xml
flags: unittests
name: codecov-umbrella
Will work automatically once you publish to PyPI with:
make publish-full
If you set up documentation hosting:
[](https://badge.fury.io/py/loglama)
[](https://pypi.org/project/loglama/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/py-lama/loglama/actions)
Add these badges as your project grows:
[](https://loglama.readthedocs.io/en/latest/)
[](https://codeclimate.com/github/py-lama/loglama/maintainability)
[](https://codeclimate.com/github/py-lama/loglama/test_coverage)
[](https://pypi.org/project/loglama/)
The provided logo is optimized for README headers and documentation.
Extract just the icon portion:
<svg viewBox="0 0 70 80" xmlns="http://www.w3.org/2000/svg">
<!-- Extract the document icon and Py symbol from the main logo -->
</svg>
For dark backgrounds, create a version with light colors:
All badges use colors that complement the logo:
#3b82f6 (matches logo gradient)#10b981 (matches accent)#f59e0b#ef4444Create custom badges using Shields.io:
Periodically verify: