neobuilder


Nameneobuilder JSON
Version 5.0.0 PyPI version JSON
download
home_pageNone
SummaryBuilds Neobuf Packages from Protobuf files using Protoplasm! :D
upload_time2024-04-15 16:22:07
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT License Copyright (c) 2022-2024 CCP Games Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords protobuf proto protoplasm dataclasses tools ccp utils
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # NeoBuilder

Builds Neobuf Packages from Protobuf files using Protoplasm! :D

## Useful info

Installing this package creates a command line executable called `neobuild` (or 
`neobuild.exe` in Windows) in Python's `Scripts` folder so you just run the 
`neobuild` command from a console.

## Usage

Assuming you've got a package called `sandbox` and you're storing your protobuf 
files in a directory called `proto` and you want to spit out the build into the 
directory `build` just go:

```
neobuild sandbox 
```

## Versioning Your Package

If you place a plain text file called `VERSION` in the root of your proto 
package (e.g. `/proto/sandbox/VERSION` from the example above) and skip any 
versioning parameters (the `--major`, `-m`, `--patch` and `-p` guys) Neobuilder
will use that file for versioning.

The first line in the file should be the semantic version number `x.y.z.a`

## More stuff

```
usage: neobuild [-h] [-m | -p] [-b [BUILDROOT]] [-v] package [protopath]

Builds neobuf packages with protoplasm.

positional arguments:
  package               Package name
  protopath             Path to the root of the protobuf files (default="./proto")

options:
  -h, --help            show this help message and exit
  -m, --major           Bump the major version number instead of the minor
  -p, --patch           Bump the patch version number instead of the minor
  -b [BUILDROOT], --buildroot [BUILDROOT]
                        Path to the root of the output build files (default="./build")
  -v, --verbose         Spits out DEBUG level logs
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "neobuilder",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "protobuf, proto, protoplasm, dataclasses, tools, ccp, utils",
    "author": null,
    "author_email": "Thordur Matthiasson <thordurm@ccpgames.com>",
    "download_url": "https://files.pythonhosted.org/packages/5d/2a/7295439f6d3c7368ec8f791586a4a7de9a465a1b61fa44247b17c0c822aa/neobuilder-5.0.0.tar.gz",
    "platform": null,
    "description": "# NeoBuilder\n\nBuilds Neobuf Packages from Protobuf files using Protoplasm! :D\n\n## Useful info\n\nInstalling this package creates a command line executable called `neobuild` (or \n`neobuild.exe` in Windows) in Python's `Scripts` folder so you just run the \n`neobuild` command from a console.\n\n## Usage\n\nAssuming you've got a package called `sandbox` and you're storing your protobuf \nfiles in a directory called `proto` and you want to spit out the build into the \ndirectory `build` just go:\n\n```\nneobuild sandbox \n```\n\n## Versioning Your Package\n\nIf you place a plain text file called `VERSION` in the root of your proto \npackage (e.g. `/proto/sandbox/VERSION` from the example above) and skip any \nversioning parameters (the `--major`, `-m`, `--patch` and `-p` guys) Neobuilder\nwill use that file for versioning.\n\nThe first line in the file should be the semantic version number `x.y.z.a`\n\n## More stuff\n\n```\nusage: neobuild [-h] [-m | -p] [-b [BUILDROOT]] [-v] package [protopath]\n\nBuilds neobuf packages with protoplasm.\n\npositional arguments:\n  package               Package name\n  protopath             Path to the root of the protobuf files (default=\"./proto\")\n\noptions:\n  -h, --help            show this help message and exit\n  -m, --major           Bump the major version number instead of the minor\n  -p, --patch           Bump the patch version number instead of the minor\n  -b [BUILDROOT], --buildroot [BUILDROOT]\n                        Path to the root of the output build files (default=\"./build\")\n  -v, --verbose         Spits out DEBUG level logs\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2022-2024 CCP Games  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Builds Neobuf Packages from Protobuf files using Protoplasm! :D",
    "version": "5.0.0",
    "project_urls": {
        "Changelog": "https://github.com/ccpgames/neobuilder/blob/main/CHANGELOG.md",
        "Documentation": "https://github.com/ccpgames/neobuilder/blob/main/README.md",
        "Homepage": "https://github.com/ccpgames/neobuilder",
        "Issues": "https://github.com/ccpgames/neobuilder/issues",
        "Repository": "https://github.com/ccpgames/neobuilder.git"
    },
    "split_keywords": [
        "protobuf",
        " proto",
        " protoplasm",
        " dataclasses",
        " tools",
        " ccp",
        " utils"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9300e7fc8b5783d12a875f72ba81b8bfbf784c5b3cb8546dc7d0c9adfd3edee1",
                "md5": "74552bbe0b8e1f2438c0bad44a2e84c5",
                "sha256": "cd31bd44da7f06e10b8888da6bcb58fd99f6c0333501e863aebfdcb896e905ff"
            },
            "downloads": -1,
            "filename": "neobuilder-5.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "74552bbe0b8e1f2438c0bad44a2e84c5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 34352,
            "upload_time": "2024-04-15T16:22:05",
            "upload_time_iso_8601": "2024-04-15T16:22:05.552483Z",
            "url": "https://files.pythonhosted.org/packages/93/00/e7fc8b5783d12a875f72ba81b8bfbf784c5b3cb8546dc7d0c9adfd3edee1/neobuilder-5.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5d2a7295439f6d3c7368ec8f791586a4a7de9a465a1b61fa44247b17c0c822aa",
                "md5": "7c5316e3a75a074a50c40f3ecfb376a3",
                "sha256": "56ef5e74ef560c83daae885ddfe32c5060b1eb444a6f2a19d3a987aacdfa58c5"
            },
            "downloads": -1,
            "filename": "neobuilder-5.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7c5316e3a75a074a50c40f3ecfb376a3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 28556,
            "upload_time": "2024-04-15T16:22:07",
            "upload_time_iso_8601": "2024-04-15T16:22:07.355675Z",
            "url": "https://files.pythonhosted.org/packages/5d/2a/7295439f6d3c7368ec8f791586a4a7de9a465a1b61fa44247b17c0c822aa/neobuilder-5.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-15 16:22:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ccpgames",
    "github_project": "neobuilder",
    "github_not_found": true,
    "lcname": "neobuilder"
}
        
Elapsed time: 0.22629s