https://github.com/kevinhowbrook/wagtail-package-template

A template for creating packages for Wagtail
https://github.com/kevinhowbrook/wagtail-package-template

wagtail

Last synced: 20 days ago
JSON representation

A template for creating packages for Wagtail

• Host: GitHub
• URL: https://github.com/kevinhowbrook/wagtail-package-template
• Owner: kevinhowbrook
• License: mit
• Created: 2019-05-18T15:13:20.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-24T05:51:51.000Z (over 1 year ago)
• Last Synced: 2024-07-29T20:30:02.335Z (4 months ago)
• Topics: wagtail
• Language: Python
• Homepage:
• Size: 9.77 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Wagtail PYPI Template

A good starting point for a wagtail pypi package.

Replace `yourapp` in these files with what you intend to build

Circle ci config example is added, once it fully configured add a badge to the readme to indicate passing:

```

[![CircleCI](https://circleci.com/gh/yourname/yourapp.svg?style=shield&circle)](https://circleci.com/gh/yourname/yourapp)

```

## Tests and coverage

The ci will run coverage and  upload a report to http://codecov.io/ if you configure the token in circle/config.yml or .github/workflows/main.yml

Add a github secret for your coverage token secrets.CODE_COV_KEY

## Publishing to PYPI

To package your app for pypi you will need twine:

```

pip install twine

```

Then run the following:

```

python setup.py sdist bdist_wheel

```

You should now have a dist/ directory:

```

twine check dist/*

```

Watch out for:

```

Checking distribution dist/PACKAGE-NAME-VERSION.tar.gz: warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.

Failed

The project's long_description has invalid markup which will not be rendered on PyPI. The following syntax errors were detected:

line 18: Warning: Inline literal start-string without end-string.

```

That's ok. twine has an issue with markdown

Get an account on https://test.pypi.org and https://pypi.org

Then run

```

twine upload --repository-url https://test.pypi.org/legacy/ dist/* * to safely check your package twine upload dist/* -- when ready to publish

```

or

``` twine upload dist/*```

:tada: