-
Create assets directory in your repository root:
mkdir -p assets
-
Save the logo as
loglama-logo.svg -
Replace the top of your README.md with the badges section
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 ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
make setup
- name: Run tests
run: |
make test
- name: Run linting
run: |
make lintAdd to your CI workflow:
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
file: ./coverage.xml
flags: unittests
name: codecov-umbrellaWill work automatically once you publish to PyPI with:
make publish-full- Go to CodeClimate.com
- Add your repository
- Replace the badge URL with your project's ID
- Go to SonarCloud.io
- Import your GitHub repository
- Replace the badge URL with your project key
If you set up documentation hosting:
- GitHub Pages: Update URL to your GitHub Pages site
- Read the Docs: Update URL to your RTD project
- Custom docs: Update URL to your documentation site
[](https://badge.fury.io/py/loglama)
[](https://pypi.org/project/webtask/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/py-lama/webtask/actions)Add these badges as your project grows:
[](https://loglama.readthedocs.io/en/latest/)
[](https://codeclimate.com/github/py-lama/webtop/maintainability)
[](https://codeclimate.com/github/py-lama/webtop/test_coverage)
[](https://pypi.org/project/webtop/)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:
- Change text to white/light gray
- Adjust gradients for better contrast
- Use lighter stroke colors
All badges use colors that complement the logo:
- Primary Blue:
#3b82f6(matches logo gradient) - Success Green:
#10b981(matches accent) - Warning Yellow:
#f59e0b - Error Red:
#ef4444
Create custom badges using Shields.io:
- Automated: Most badges update automatically
- Manual: Update version numbers in custom badges when releasing
- Monitoring: Regularly check that all badges are working
Periodically verify:
- All badges load correctly
- Links point to correct resources
- No broken or outdated badges
- Consistent styling across badges
- Badge not updating: Clear browser cache or check service status
- Wrong repository: Ensure URLs point to correct GitHub repository
- Build badge failing: Check GitHub Actions configuration
- Coverage badge missing: Ensure coverage reports are uploaded