https://github.com/romnn/proto-compile

helper package that wraps protoc for your CI and projects.
https://github.com/romnn/proto-compile

ci compiler cpp dart golang grpc grpc-web helper java javascript protobuf python typescript

Last synced: about 2 months ago
JSON representation

helper package that wraps protoc for your CI and projects.

• Host: GitHub
• URL: https://github.com/romnn/proto-compile
• Owner: romnn
• License: mit
• Created: 2021-09-05T20:12:32.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-13T10:27:00.000Z (3 months ago)
• Last Synced: 2024-11-17T04:43:05.797Z (about 2 months ago)
• Topics: ci, compiler, cpp, dart, golang, grpc, grpc-web, helper, java, javascript, protobuf, python, typescript
• Language: Python
• Homepage:
• Size: 160 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
===============================

proto-compile

===============================

.. image:: https://github.com/romnn/proto-compile/workflows/test/badge.svg

        :target: https://github.com/romnn/proto-compile/actions

        :alt: Build Status

.. image:: https://img.shields.io/pypi/v/proto-compile.svg

        :target: https://pypi.python.org/pypi/proto-compile

        :alt: PyPI version

.. image:: https://img.shields.io/github/license/romnn/proto-compile

        :target: https://github.com/romnn/proto-compile

        :alt: License

.. image:: https://codecov.io/gh/romnn/proto-compile/branch/master/graph/badge.svg

        :target: https://codecov.io/gh/romnn/proto-compile

        :alt: Test Coverage

""""""""

Your short description here.

.. code-block:: console

    $ pip install proto-compile

Usage

-----

.. code-block:: python

    import proto_compile

Tests

~~~~~~~

You can run tests with

.. code-block:: console

    $ invoke test

    $ invoke type-check                 # Run mypy type checks

Linting and formatting

~~~~~~~~~~~~~~~~~~~~~~~~

Lint and format the code with

.. code-block:: console

    $ invoke format

    $ invoke lint

All of this happens when you run ``invoke pre-commit``.

Note

-----

This project is still in the alpha stage and should not be considered production ready.