Name | cthulhucli JSON |
Version |
1.0.3
JSON |
| download |
home_page | None |
Summary | A command line interface for browsing cards from the Call of Cthulhu CCG and LCG. |
upload_time | 2024-07-02 13:58:31 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.6 |
license | None |
keywords |
call of cthulhu
ccg
cthulhu
lcg
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
Call of Cthulhu CLI
===================
A command line interface for browsing cards from [Call of Cthulhu CCG and LCG](https://www.fantasyflightgames.com/en/products/call-of-cthulhu-lcg/).
Install
-------
Call of Cthulhu CLI can be installed from [PyPI](https://pypi.python.org/pypi/cthulhucli) using pip:
sudo pip install cthulhucli
Options
-------
Call of Cthulhu CLI has the following options as given by the --help option:
```console
$ cthulhucli --help
Usage: cthulhucli [OPTIONS] [TEXT]...
Options:
--ccg Search CCG era cards only.
--lcg Search LCG era cards only.
-v, --verbose Show more data.
--brief Show one line of data, regardless the level of verbose.
--long Show multiple lines of data, regardless the level of verbose.
--show FIELD Show given field only. Can be repeated to show multiple
fields in given order.
--case Use case sensitive filtering.
--exact Use exact match filtering.
--regex Use regular rexpressions when filtering.
--or FIELD Treat multiple tests for given field with logical
disjunction, i.e. OR-logic instead of AND-logic.
--inclusive Treat multiple tests for different fields with logical
disjunction, i.e. OR-logic instead of AND-logic.
--sort FIELD Sort results by given field.
--desc Sort results in descending order.
--group FIELD Group results by given field.
--count FIELD Print a breakdown of all values for given field.
--version Show the version and exit.
--help Show this message and exit.
Field filters:
-n, --name TEXT Filter on matching name.
--descriptor TEXT Filter on matching descriptor.
--subtype TEXT Filter on matching subtypes.
-x, --text TEXT Filter on matching text.
--keyword TEXT Filter on matching keywords.
--unique Filter on uniqueness.
--non-unique Filter on non-uniqueness.
--faction FACTION Filter on matching faction.
--faction-isnt FACTION Filter on non-matching faction.
--type CARD TYPE Filter on matching card type.
--type-isnt CARD TYPE Filter on non-matching card type.
--cost NUMBER Filter on matching cost (number comparison).
--skill NUMBER Filter on matching skill (number comparison).
--terror NUMBER Filter on number of terror icons.
--combat NUMBER Filter on number of combat icons.
--arcane NUMBER Filter on number of arcance icons.
--investigation NUMBER Filter on number of investigation icons.
--set TEXT Filter on matching set.
--restricted Filter on restricted.
--non-restricted Filter on non-restricted.
--banned Filter on banned.
--non-banned Filter on non-banned.
Where:
CARD TYPE One of: character, conspiracy, event, story, support.
FACTION One of: agency, cthulhu, hastur, miskatonic university, neutral,
shub-niggurath, silver twilight, syndicate, the agency, yog-
sothoth.
FIELD One of: banned, card type, cost, descriptor, faction, icons,
keywords, name, restricted, set, skill, subtypes, text,
uniqueness.
NUMBER A number optionally prefixed by one of the supported comparison
operators: ==, =, !=, !, <=, <, >=, >. With == being the default
if only a number is given.
TEXT A text partially matching the field value. The --case, --regex
and --exact options can be applied. If prefixed with ! the match
is negated.
```
Examples
--------
Find a card by its name:
```console
$ cthulhucli --name Nyarlathotep
Nyarlathotep: Unique. Neutral. Character. Cost 0. Skill 6. [TTCCA].
Nyarlathotep: Unique. Neutral. Character. Cost 4. Skill 4. [TCAI].
Nyarlathotep: Unique. Neutral. Character. Cost 5. Skill 6. [TCAI].
Total count: 3
```
Print more of the cards' information:
```console
$ cthulhucli --name Nyarlathotep -v
Nyarlathotep
The Crawling Chaos
Ancient One.
Villainous. Toughness +4.
Each Avatar of Nyarlathotep character gains (T)(T).
Action: pay 3 to take control of an Avatar of Nyarlathotep character.
Unique: Yes
Faction: Neutral
Card Type: Character
Cost: 0
Skill: 6
Icons: TTCCA
Nyarlathotep
The Black Pharaoh
Ancient One.
Villainous. Toughness +2.
During the resource phase, if an opponent wishes to attach a resource to a domain, the resource must be chosen at random from his hand. (Choose the domain first, then randomly determine the resource.)
Unique: Yes
Faction: Neutral
Card Type: Character
Cost: 4
Skill: 4
Icons: TCAI
Nyarlathotep
The Crawling Chaos
Ancient One.
Villainous. Toughness +1. Resilient.
You may return an Avatar character to your hand to reduce the cost to play Nyarlathotep by 3.
Disrupt: When you succeed at a story to which Nyarlathotep is committed, sacrifice it to put an Avatar character into play from your hand committed to an unresolved story, if able.
Unique: Yes
Faction: Neutral
Card Type: Character
Cost: 5
Skill: 6
Icons: TCAI
Total count: 3
```
Find all events with the *Day* or *Night* subtype:
```console
$ cthulhucli --subtype day --subtype night --or subtype --type event
Blessed Dawn: The Agency. Event. Cost X.
The Punishing Sun: Miskatonic University. Event. Cost X.
Howl of Jackals: Cthulhu. Event. Cost X.
Enshrouded Sun: Hastur. Event. Cost X.
Screaming of the Spheres: Yog-Sothoth. Event. Cost X.
Buzzing of Locusts: Shub-Niggurath. Event. Cost X.
Blinding Light: Neutral. Event. Cost 4.
Calling Forth the Abyss: Neutral. Event. Cost 4.
Total count: 8
```
Find all non-unique Miskatonic *Investigator* characters from the CCG era, grouped by cost:
```console
$ cthulhucli --non-unique --faction misk --subtype investigator --ccg --group cost
[ Cost 1 ]
Campus Gumshoe: Miskatonic University. Character. Cost 1. Skill 2. [CA].
Graduate Assistant: Miskatonic University. Character. Cost 1. Skill 2. No Icons.
Reclusive Researcher: Miskatonic University. Character. Cost 1. Skill 1. [II].
[ Cost 2 ]
Absent-Minded Accountant: Miskatonic University. Character. Cost 2. Skill 1. [AI].
Civil Engineer: Miskatonic University. Character. Cost 2. Skill X. [AI].
Cryptozoologist: Miskatonic University. Character. Cost 2. Skill 3. [A].
Field Researcher: Miskatonic University. Character. Cost 2. Skill 1. [I].
Mad Genius: Miskatonic University. Character. Cost 2. Skill 2. No Icons.
Strange Librarian: Miskatonic University. Character. Cost 2. Skill 1. [A].
Student Archaeologist: Miskatonic University. Character. Cost 2. Skill 2. [I].
[ Cost 3 ]
Anthropology Advisor: Miskatonic University. Character. Cost 3. Skill 2. [C].
Classicist: Miskatonic University. Character. Cost 3. Skill 3. [III].
Local Historian: Miskatonic University. Character. Cost 3. Skill 1. [AI].
Natural Philosopher: Miskatonic University. Character. Cost 3. Skill 3. [AI].
Professor of Metaphysics: Miskatonic University. Character. Cost 3. Skill 2. [II].
Seeker of the Profane: Miskatonic University. Character. Cost 3. Skill 2. [AI].
Two-Fisted Archaeologist: Miskatonic University. Character. Cost 3. Skill 6. No Icons.
[ Cost 4 ]
Theology Professor: Miskatonic University. Character. Cost 4. Skill 4. [AAII].
[ Cost 5 ]
Professor of Archaeology: Miskatonic University. Character. Cost 5. Skill 3. [CI].
Total count: 19
```
Find all characters with struggle boosters, displaying their full text:
```console
$ cthulhucli --type char --text "\(\([CTAI]\)\)" --regex --show text
Cairo Mercenary
((C))((C))
Decommissioned Officer
((C))
Local Historian
((I))
Professor of Archaeology
((I))((I))
Elder Shoggoth
((T))
Servant of the Key
((A))
Relentless Stalker
Willpower. Toughness +1.
When you would uncommit Relentless Stalker from a story, you may choose to not uncommit it until the story is won.
((C))
A Scheme of Byakhees
Forced Response: After you win a (T) struggle at a story to which A Scheme of Byakhees is committed, the losing player must either discard a card from his hand, or drive a character he controls insane.
((T))((T))
Hastur
Lower the cost to play Hastur by 1 for each insane character in play.
Villainous. Invulnerability. Fast.
When you win a (T) struggle at a story, place a success token on that story.
((T))
Total count: 9
```
Find all 0 cost characters and get a breakdown of their faction, icons and subtypes:
```console
$ cthulhucli --type char --cost 0 --count faction --count icons --count subtype
[ Faction counts ]
Neutral: 4
Yog-Sothoth: 3
Cthulhu: 2
Miskatonic University: 2
Silver Twilight: 2
Hastur: 2
Shub-Niggurath: 1
The Agency: 1
[ Icons counts ]
Terror: 10
Combat: 4
Arcane: 3
Investigation: 1
[ Subtypes counts ]
Cultist: 5
Conspirator: 2
Servitor: 2
Investigator: 2
Ancient One: 1
Phantom: 1
Independent: 1
Monster: 1
Student: 1
Artist: 1
Lodge: 1
Total count: 17
```
Credits
-------
* All card data is copyright by [Fantasy Flight Games](https://www.fantasyflightgames.com/).
* Call of Cthulhu CLI is written by [Petter Nyström](mailto:jimorie@gmail.com).
Raw data
{
"_id": null,
"home_page": null,
"name": "cthulhucli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "call of cthulhu, ccg, cthulhu, lcg",
"author": null,
"author_email": "Petter Nystr\u00f6m <jimorie@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/98/e1/b355274ccfb66ae9d9d66cee9d05c783a06a9ca2db512a3138b1fd1e297a/cthulhucli-1.0.3.tar.gz",
"platform": null,
"description": "Call of Cthulhu CLI\n===================\n\nA command line interface for browsing cards from [Call of Cthulhu CCG and LCG](https://www.fantasyflightgames.com/en/products/call-of-cthulhu-lcg/).\n\nInstall\n-------\n\nCall of Cthulhu CLI can be installed from [PyPI](https://pypi.python.org/pypi/cthulhucli) using pip:\n\n sudo pip install cthulhucli\n\nOptions\n-------\n\nCall of Cthulhu CLI has the following options as given by the --help option:\n\n```console\n$ cthulhucli --help\nUsage: cthulhucli [OPTIONS] [TEXT]...\n\nOptions:\n --ccg Search CCG era cards only.\n --lcg Search LCG era cards only.\n -v, --verbose Show more data.\n --brief Show one line of data, regardless the level of verbose.\n --long Show multiple lines of data, regardless the level of verbose.\n --show FIELD Show given field only. Can be repeated to show multiple\n fields in given order.\n --case Use case sensitive filtering.\n --exact Use exact match filtering.\n --regex Use regular rexpressions when filtering.\n --or FIELD Treat multiple tests for given field with logical\n disjunction, i.e. OR-logic instead of AND-logic.\n --inclusive Treat multiple tests for different fields with logical\n disjunction, i.e. OR-logic instead of AND-logic.\n --sort FIELD Sort results by given field.\n --desc Sort results in descending order.\n --group FIELD Group results by given field.\n --count FIELD Print a breakdown of all values for given field.\n --version Show the version and exit.\n --help Show this message and exit.\n\nField filters:\n -n, --name TEXT Filter on matching name.\n --descriptor TEXT Filter on matching descriptor.\n --subtype TEXT Filter on matching subtypes.\n -x, --text TEXT Filter on matching text.\n --keyword TEXT Filter on matching keywords.\n --unique Filter on uniqueness.\n --non-unique Filter on non-uniqueness.\n --faction FACTION Filter on matching faction.\n --faction-isnt FACTION Filter on non-matching faction.\n --type CARD TYPE Filter on matching card type.\n --type-isnt CARD TYPE Filter on non-matching card type.\n --cost NUMBER Filter on matching cost (number comparison).\n --skill NUMBER Filter on matching skill (number comparison).\n --terror NUMBER Filter on number of terror icons.\n --combat NUMBER Filter on number of combat icons.\n --arcane NUMBER Filter on number of arcance icons.\n --investigation NUMBER Filter on number of investigation icons.\n --set TEXT Filter on matching set.\n --restricted Filter on restricted.\n --non-restricted Filter on non-restricted.\n --banned Filter on banned.\n --non-banned Filter on non-banned.\n\nWhere:\n CARD TYPE One of: character, conspiracy, event, story, support.\n FACTION One of: agency, cthulhu, hastur, miskatonic university, neutral,\n shub-niggurath, silver twilight, syndicate, the agency, yog-\n sothoth.\n FIELD One of: banned, card type, cost, descriptor, faction, icons,\n keywords, name, restricted, set, skill, subtypes, text,\n uniqueness.\n NUMBER A number optionally prefixed by one of the supported comparison\n operators: ==, =, !=, !, <=, <, >=, >. With == being the default\n if only a number is given.\n TEXT A text partially matching the field value. The --case, --regex\n and --exact options can be applied. If prefixed with ! the match\n is negated.\n```\n\nExamples\n--------\n\nFind a card by its name:\n\n```console\n$ cthulhucli --name Nyarlathotep\nNyarlathotep: Unique. Neutral. Character. Cost 0. Skill 6. [TTCCA].\nNyarlathotep: Unique. Neutral. Character. Cost 4. Skill 4. [TCAI].\nNyarlathotep: Unique. Neutral. Character. Cost 5. Skill 6. [TCAI].\n\nTotal count: 3\n```\n\nPrint more of the cards' information:\n\n```console\n$ cthulhucli --name Nyarlathotep -v\nNyarlathotep\nThe Crawling Chaos\nAncient One.\nVillainous. Toughness +4.\nEach Avatar of Nyarlathotep character gains (T)(T).\nAction: pay 3 to take control of an Avatar of Nyarlathotep character.\nUnique: Yes\nFaction: Neutral\nCard Type: Character\nCost: 0\nSkill: 6\nIcons: TTCCA\n\nNyarlathotep\nThe Black Pharaoh\nAncient One.\nVillainous. Toughness +2.\nDuring the resource phase, if an opponent wishes to attach a resource to a domain, the resource must be chosen at random from his hand. (Choose the domain first, then randomly determine the resource.)\nUnique: Yes\nFaction: Neutral\nCard Type: Character\nCost: 4\nSkill: 4\nIcons: TCAI\n\nNyarlathotep\nThe Crawling Chaos\nAncient One.\nVillainous. Toughness +1. Resilient.\nYou may return an Avatar character to your hand to reduce the cost to play Nyarlathotep by 3.\nDisrupt: When you succeed at a story to which Nyarlathotep is committed, sacrifice it to put an Avatar character into play from your hand committed to an unresolved story, if able.\nUnique: Yes\nFaction: Neutral\nCard Type: Character\nCost: 5\nSkill: 6\nIcons: TCAI\n\nTotal count: 3\n```\n\nFind all events with the *Day* or *Night* subtype:\n\n```console\n$ cthulhucli --subtype day --subtype night --or subtype --type event\nBlessed Dawn: The Agency. Event. Cost X.\nThe Punishing Sun: Miskatonic University. Event. Cost X.\nHowl of Jackals: Cthulhu. Event. Cost X.\nEnshrouded Sun: Hastur. Event. Cost X.\nScreaming of the Spheres: Yog-Sothoth. Event. Cost X.\nBuzzing of Locusts: Shub-Niggurath. Event. Cost X.\nBlinding Light: Neutral. Event. Cost 4.\nCalling Forth the Abyss: Neutral. Event. Cost 4.\n\nTotal count: 8\n```\n\nFind all non-unique Miskatonic *Investigator* characters from the CCG era, grouped by cost:\n\n```console\n$ cthulhucli --non-unique --faction misk --subtype investigator --ccg --group cost\n[ Cost 1 ]\n\nCampus Gumshoe: Miskatonic University. Character. Cost 1. Skill 2. [CA].\nGraduate Assistant: Miskatonic University. Character. Cost 1. Skill 2. No Icons.\nReclusive Researcher: Miskatonic University. Character. Cost 1. Skill 1. [II].\n\n[ Cost 2 ]\n\nAbsent-Minded Accountant: Miskatonic University. Character. Cost 2. Skill 1. [AI].\nCivil Engineer: Miskatonic University. Character. Cost 2. Skill X. [AI].\nCryptozoologist: Miskatonic University. Character. Cost 2. Skill 3. [A].\nField Researcher: Miskatonic University. Character. Cost 2. Skill 1. [I].\nMad Genius: Miskatonic University. Character. Cost 2. Skill 2. No Icons.\nStrange Librarian: Miskatonic University. Character. Cost 2. Skill 1. [A].\nStudent Archaeologist: Miskatonic University. Character. Cost 2. Skill 2. [I].\n\n[ Cost 3 ]\n\nAnthropology Advisor: Miskatonic University. Character. Cost 3. Skill 2. [C].\nClassicist: Miskatonic University. Character. Cost 3. Skill 3. [III].\nLocal Historian: Miskatonic University. Character. Cost 3. Skill 1. [AI].\nNatural Philosopher: Miskatonic University. Character. Cost 3. Skill 3. [AI].\nProfessor of Metaphysics: Miskatonic University. Character. Cost 3. Skill 2. [II].\nSeeker of the Profane: Miskatonic University. Character. Cost 3. Skill 2. [AI].\nTwo-Fisted Archaeologist: Miskatonic University. Character. Cost 3. Skill 6. No Icons.\n\n[ Cost 4 ]\n\nTheology Professor: Miskatonic University. Character. Cost 4. Skill 4. [AAII].\n\n[ Cost 5 ]\n\nProfessor of Archaeology: Miskatonic University. Character. Cost 5. Skill 3. [CI].\n\nTotal count: 19\n```\n\nFind all characters with struggle boosters, displaying their full text:\n\n```console\n$ cthulhucli --type char --text \"\\(\\([CTAI]\\)\\)\" --regex --show text\nCairo Mercenary\n((C))((C))\n\nDecommissioned Officer\n((C))\n\nLocal Historian\n((I))\n\nProfessor of Archaeology\n((I))((I))\n\nElder Shoggoth\n((T))\n\nServant of the Key\n((A))\n\nRelentless Stalker\nWillpower. Toughness +1.\nWhen you would uncommit Relentless Stalker from a story, you may choose to not uncommit it until the story is won.\n((C))\n\nA Scheme of Byakhees\nForced Response: After you win a (T) struggle at a story to which A Scheme of Byakhees is committed, the losing player must either discard a card from his hand, or drive a character he controls insane.\n((T))((T))\n\nHastur\nLower the cost to play Hastur by 1 for each insane character in play.\nVillainous. Invulnerability. Fast.\nWhen you win a (T) struggle at a story, place a success token on that story.\n((T))\n\nTotal count: 9\n```\n\nFind all 0 cost characters and get a breakdown of their faction, icons and subtypes:\n\n```console\n$ cthulhucli --type char --cost 0 --count faction --count icons --count subtype\n[ Faction counts ]\n\nNeutral: 4\nYog-Sothoth: 3\nCthulhu: 2\nMiskatonic University: 2\nSilver Twilight: 2\nHastur: 2\nShub-Niggurath: 1\nThe Agency: 1\n\n[ Icons counts ]\n\nTerror: 10\nCombat: 4\nArcane: 3\nInvestigation: 1\n\n[ Subtypes counts ]\n\nCultist: 5\nConspirator: 2\nServitor: 2\nInvestigator: 2\nAncient One: 1\nPhantom: 1\nIndependent: 1\nMonster: 1\nStudent: 1\nArtist: 1\nLodge: 1\n\nTotal count: 17\n```\n\nCredits\n-------\n\n* All card data is copyright by [Fantasy Flight Games](https://www.fantasyflightgames.com/).\n* Call of Cthulhu CLI is written by [Petter Nystr\u00f6m](mailto:jimorie@gmail.com).\n",
"bugtrack_url": null,
"license": null,
"summary": "A command line interface for browsing cards from the Call of Cthulhu CCG and LCG.",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/jimorie/cthulhucli"
},
"split_keywords": [
"call of cthulhu",
" ccg",
" cthulhu",
" lcg"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38696545e08db94b4c753d2397353e6977f6cdb3f825cbf0e086c6be23d22725",
"md5": "dfc6a9a791d9b5b87569545257f2f25f",
"sha256": "88ee07ef490a761640aaf59f863684f641d9f8f5a7ddf800f9e227cd13764998"
},
"downloads": -1,
"filename": "cthulhucli-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dfc6a9a791d9b5b87569545257f2f25f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 185193,
"upload_time": "2024-07-02T13:58:30",
"upload_time_iso_8601": "2024-07-02T13:58:30.010008Z",
"url": "https://files.pythonhosted.org/packages/38/69/6545e08db94b4c753d2397353e6977f6cdb3f825cbf0e086c6be23d22725/cthulhucli-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98e1b355274ccfb66ae9d9d66cee9d05c783a06a9ca2db512a3138b1fd1e297a",
"md5": "ba6d93d67843abc3e5aa84f44d12897d",
"sha256": "238ebf51a2d47dd756356257502623e8b6498f6645ac0c241d155af0b13699a8"
},
"downloads": -1,
"filename": "cthulhucli-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "ba6d93d67843abc3e5aa84f44d12897d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 178266,
"upload_time": "2024-07-02T13:58:31",
"upload_time_iso_8601": "2024-07-02T13:58:31.400653Z",
"url": "https://files.pythonhosted.org/packages/98/e1/b355274ccfb66ae9d9d66cee9d05c783a06a9ca2db512a3138b1fd1e297a/cthulhucli-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-02 13:58:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jimorie",
"github_project": "cthulhucli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cthulhucli"
}