| Name | neobuilder JSON |
| Version |
5.3.1
JSON |
| download |
| home_page | None |
| Summary | Builds Neobuf Packages from Protobuf files using Protoplasm! :D |
| upload_time | 2024-10-15 12:26:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| 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. |
| keywords |
protobuf
proto
protoplasm
dataclasses
tools
ccp
utils
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
protoplasm
ccptools
Jinja2
semver
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NeoBuilder
Builds Neobuf Packages from Protobuf files using Protoplasm! :D
## Super Important Info
Neobuilder releases are NOT guaranteed to be backwards compatible with older
versions of Protoplasm and trying to run Neobuilder built code in a Protoplasm
release who's major and/or minor versions lag behind will more often than not
just break.
A difference in the patch version should most often be fine, as should using a
Protoplasm release that's one or more minor versions ahead of the Neobuilder
used to build code.
## Versioning
The versioning of Neobuilder and Protoplasm (major and minor versions) go hand
in hand; i.e. when Protoplasm's major of minor versions bump, a new NeoBuilder
should also be released with the same major and minor version, even if there's
no actual code change needed in NeoBuilder to support whatever changed in
Protoplasm.
Note that in order to simplify and ease this synchronous development, release
and versioning, the NeoBuilder package for the latest Protoplasm should
generally NOT be dependent on any new features added to that package, so that
the NeoBuilder package can be built and released FIRST and it can build code for
its corresponding Protoplasm version, withing having that latest version
actually installed.
This is done in order to not create a circular dependency on features between
the two but instead have NeoBuilder only depend on the previous version of
Protoplasm, especially for its pre-release unit-tests, and instead allow
Protoplasm to fully depend on the latest NeoBuilder for its unit-tests.
## 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: neobuilder.py [-h] [-m | -p] [-b [BUILDROOT]] [-v] [-i] [-I INCLUDE] package [protopath]
Builds neobuf packages with protoplasm.
positional arguments:
package Package name
protopath Path to the root of the protobuf files (default="./proto")
optional arguments:
-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
-i, --pyi Builds *.pyi for the pb2 files as well (default=False)
-I INCLUDE, --include INCLUDE
Optional additional proto paths to include (can be used multiple times)
Neobuilder v5.3.1 - Protoplasm v5.2.0
```
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/50/31/51703a36a14a5dff2fb5c0f7bc68312167cbc4a9ba7f0fa6845356d23665/neobuilder-5.3.1.tar.gz",
"platform": null,
"description": "# NeoBuilder\n\nBuilds Neobuf Packages from Protobuf files using Protoplasm! :D\n\n## Super Important Info\n\nNeobuilder releases are NOT guaranteed to be backwards compatible with older \nversions of Protoplasm and trying to run Neobuilder built code in a Protoplasm \nrelease who's major and/or minor versions lag behind will more often than not \njust break.\n\nA difference in the patch version should most often be fine, as should using a \nProtoplasm release that's one or more minor versions ahead of the Neobuilder \nused to build code. \n\n## Versioning\n\nThe versioning of Neobuilder and Protoplasm (major and minor versions) go hand \nin hand; i.e. when Protoplasm's major of minor versions bump, a new NeoBuilder \nshould also be released with the same major and minor version, even if there's \nno actual code change needed in NeoBuilder to support whatever changed in \nProtoplasm.\n\nNote that in order to simplify and ease this synchronous development, release \nand versioning, the NeoBuilder package for the latest Protoplasm should \ngenerally NOT be dependent on any new features added to that package, so that \nthe NeoBuilder package can be built and released FIRST and it can build code for\nits corresponding Protoplasm version, withing having that latest version \nactually installed.\n\nThis is done in order to not create a circular dependency on features between \nthe two but instead have NeoBuilder only depend on the previous version of \nProtoplasm, especially for its pre-release unit-tests, and instead allow \nProtoplasm to fully depend on the latest NeoBuilder for its unit-tests.\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: neobuilder.py [-h] [-m | -p] [-b [BUILDROOT]] [-v] [-i] [-I INCLUDE] 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\noptional arguments:\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 -i, --pyi Builds *.pyi for the pb2 files as well (default=False)\n -I INCLUDE, --include INCLUDE\n Optional additional proto paths to include (can be used multiple times)\n\nNeobuilder v5.3.1 - Protoplasm v5.2.0\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.3.1",
"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": "98d1ec7e3a6ac5ab330a6506612b7d51c6df5f11ce22212b12764b965599ef3e",
"md5": "ef4e304695f02570bfd3ee866b938a2f",
"sha256": "399fa3b747dd7284530330295ddcd5f07769a123312dd182d0a4df0bc0d65d1e"
},
"downloads": -1,
"filename": "neobuilder-5.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef4e304695f02570bfd3ee866b938a2f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35886,
"upload_time": "2024-10-15T12:26:19",
"upload_time_iso_8601": "2024-10-15T12:26:19.731724Z",
"url": "https://files.pythonhosted.org/packages/98/d1/ec7e3a6ac5ab330a6506612b7d51c6df5f11ce22212b12764b965599ef3e/neobuilder-5.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "503151703a36a14a5dff2fb5c0f7bc68312167cbc4a9ba7f0fa6845356d23665",
"md5": "e9d22d9dbac4850570c299bc3f25d62e",
"sha256": "ea17708e7ef851909fc90e834e82f296dd31cccc51ce172fef96004a219683c6"
},
"downloads": -1,
"filename": "neobuilder-5.3.1.tar.gz",
"has_sig": false,
"md5_digest": "e9d22d9dbac4850570c299bc3f25d62e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30952,
"upload_time": "2024-10-15T12:26:20",
"upload_time_iso_8601": "2024-10-15T12:26:20.622462Z",
"url": "https://files.pythonhosted.org/packages/50/31/51703a36a14a5dff2fb5c0f7bc68312167cbc4a9ba7f0fa6845356d23665/neobuilder-5.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 12:26:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ccpgames",
"github_project": "neobuilder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "protoplasm",
"specs": [
[
"<",
"6"
],
[
">=",
"5.3"
]
]
},
{
"name": "ccptools",
"specs": [
[
"<",
"2"
],
[
">=",
"1.1"
]
]
},
{
"name": "Jinja2",
"specs": [
[
">=",
"3.1"
],
[
"<",
"4"
]
]
},
{
"name": "semver",
"specs": [
[
"<",
"4"
],
[
">=",
"3.0.2"
]
]
}
],
"lcname": "neobuilder"
}
