| Name | cpfr-gadb JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | A small tool that crawls a directory for files matching certain wildcards and maintaining a CSV file with all of the files. |
| upload_time | 2025-08-10 17:53:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
game asset
asset
game asset db
csv
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Game Asset DB (GADB)
The game asset DB script crawls your asset directory for files you specify via wildcard patterns
and writes the list into a CSV file. You can also specify columns you wish to add for metadata.
This way, you can easily track metadata for your assets (for example where you downloaded the asset,
who the author is and what the license terms are).
It is recommended to store the csv file under version control (such as git) to track changes to your assets
and to run the script frequently. You can then open it up in your favorite spreadsheet application and
manage the metadata for your assets or create exports for credits, license audits etc.
The script uses a yaml config file (usually 'gadb.yml', but it can be changed using the '-c' command line option).
A sample config file looks like the following:
gadb.yml
```
db: gadb.csv
delimiter: ","
wildcards:
- assets/**/*.xcf
- assets/**/*.ogg
columns:
- URL
- Description
- Author
- Date
- License
```
In the example, the CSV database file is specified as 'gadb.csv'.
The delimiter for the CSV im- and export is specified as ',' (which is important for languages where the comma is used for number formatting)
The wildcards option specifies which files are being crawled
And the columns list specifies which metadata columns should be used in the CSV.
You can either copy the `gadb/__init__.py` file as `gadb.py` to your directory and run it like this:
python gadb.py
or
python gadb.py -c myConfigFile.yml
if you want to use a custom config file name.
The script then tries to read any old gadb.csv file, list the current files and merge the data from the old file into the new list of files.
The other way would be to install `cpfr-gadb` via PIP, so you can just run it as
gadb
or
gadb -c myConfigFile.yml
Raw data
{
"_id": null,
"home_page": null,
"name": "cpfr-gadb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Game Asset, Asset, Game Asset DB, CSV",
"author": null,
"author_email": "Carsten Pfeffer <pfeffer.carsten@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8c/a0/f06b19dc594d025cd9f873efcf46affbe3b84fe09b892c88bc894970722b/cpfr_gadb-1.0.0.tar.gz",
"platform": null,
"description": "# Game Asset DB (GADB)\n\nThe game asset DB script crawls your asset directory for files you specify via wildcard patterns\nand writes the list into a CSV file. You can also specify columns you wish to add for metadata.\nThis way, you can easily track metadata for your assets (for example where you downloaded the asset,\nwho the author is and what the license terms are).\nIt is recommended to store the csv file under version control (such as git) to track changes to your assets\nand to run the script frequently. You can then open it up in your favorite spreadsheet application and\nmanage the metadata for your assets or create exports for credits, license audits etc.\n\nThe script uses a yaml config file (usually 'gadb.yml', but it can be changed using the '-c' command line option).\nA sample config file looks like the following:\n\ngadb.yml\n```\ndb: gadb.csv\ndelimiter: \",\"\nwildcards:\n- assets/**/*.xcf\n- assets/**/*.ogg\ncolumns:\n- URL\n- Description\n- Author\n- Date\n- License\n```\n\nIn the example, the CSV database file is specified as 'gadb.csv'.\nThe delimiter for the CSV im- and export is specified as ',' (which is important for languages where the comma is used for number formatting)\nThe wildcards option specifies which files are being crawled\nAnd the columns list specifies which metadata columns should be used in the CSV.\n\nYou can either copy the `gadb/__init__.py` file as `gadb.py` to your directory and run it like this:\n\n python gadb.py\n\nor\n\n python gadb.py -c myConfigFile.yml\n\nif you want to use a custom config file name.\nThe script then tries to read any old gadb.csv file, list the current files and merge the data from the old file into the new list of files.\n\nThe other way would be to install `cpfr-gadb` via PIP, so you can just run it as\n\n gadb\n\nor\n\n gadb -c myConfigFile.yml\n",
"bugtrack_url": null,
"license": null,
"summary": "A small tool that crawls a directory for files matching certain wildcards and maintaining a CSV file with all of the files.",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"game asset",
" asset",
" game asset db",
" csv"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cb02743edb0bd20313be2f3d8077f721f90fb4cb63f6e2c8adad3329821b37f9",
"md5": "1db676ff1c101d7d0de5412c255188a7",
"sha256": "451b6b8e4957a37761fb660171ff0676ca831f9324ca2c03b38354117dbb3f47"
},
"downloads": -1,
"filename": "cpfr_gadb-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1db676ff1c101d7d0de5412c255188a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4835,
"upload_time": "2025-08-10T17:53:05",
"upload_time_iso_8601": "2025-08-10T17:53:05.977470Z",
"url": "https://files.pythonhosted.org/packages/cb/02/743edb0bd20313be2f3d8077f721f90fb4cb63f6e2c8adad3329821b37f9/cpfr_gadb-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8ca0f06b19dc594d025cd9f873efcf46affbe3b84fe09b892c88bc894970722b",
"md5": "fa96f817b1c247597846738989777e1f",
"sha256": "d23e9a10cdda76dd93f237534ddbf60998586b002cd4873259cd94eaed38116e"
},
"downloads": -1,
"filename": "cpfr_gadb-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "fa96f817b1c247597846738989777e1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3955,
"upload_time": "2025-08-10T17:53:07",
"upload_time_iso_8601": "2025-08-10T17:53:07.231495Z",
"url": "https://files.pythonhosted.org/packages/8c/a0/f06b19dc594d025cd9f873efcf46affbe3b84fe09b892c88bc894970722b/cpfr_gadb-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-10 17:53:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cpfr-gadb"
}
