<div align="center">
# WarMAC Version 0.0.4
[](https://github.com/Eutropios/WarMAC)
[](https://warmac.readthedocs.io/en/latest/?badge=latest)
[](https://results.pre-commit.ci/latest/github/Eutropios/WarMAC/main)
[](https://pypi.org/project/warmac/)
[](https://pypi.org/project/warmac/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/Eutropios/WarMAC)
[](https://pypi.org/project/warmac/)
</div>
**WarMAC** is a command-line Python script that can calculate the average market price of items in Warframe.
**WarMAC** compiles orders from the fan website *<https://warframe.market/>* and can be used to find the average prices of prime parts, tradeable parts, relics, mods, and arcane enhancements.
## Features
* 🎮Target PC, PlayStation, XBOX, or Nintendo Switch platforms.
* 📈Calculate the median, mean, mode, harmonic mean, or geometric means of items.
* 🕜Restrict orders to specific time ranges.
* 💰Utilize either seller or buyer orders.
* ⛏️Find averages for intact or radiant relics.
* ✨Find averages for unranked or max-ranked mods and arcane enhancements.
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [Documentation](#documentation)
* [Upcoming Features](#upcoming-features)
* [Contributing](#contributing)
* [Acknowledgements](#acknowledgements)
* [Licensing](#licensing)
## Installation<a id="installation"></a> <!--This ensures PyPI compatibility-->
WarMAC only supports Python versions 3.8 to 3.12. There are currently no plans to add support to Python 3.7
### Using pipx
Currently, the primary method of installing WarMAC is by installing it through [pipx](https://pypa.github.io/pipx/). This keeps WarMAC and its dependencies separate from your global Python packages. Installation can be done using the following command:
| Platform | Command |
|---|---|
| UNIX/MacOS | `python -m pipx install warmac` |
| Windows | `py -m pipx install warmac` |
You can ensure that you've installed WarMAC correctly by calling its help page like so:
```bash
warmac --version
```
### Using Pip
Using pip alone to install WarMAC will work just as well. Installation can be done using the following command:
| Platform | Command |
|---|---|
| UNIX/MacOS | `python -m pip install warmac` |
| Windows | `py -m pip install warmac` |
You can ensure that you've installed WarMAC correctly by calling its help page like so:
```bash
warmac --version
```
### Using Poetry
WarMAC can also be installed using [Poetry](https://python-poetry.org/) either through the provided [`poetry.lock`](https://github.com/Eutropios/WarMAC/blob/main/poetry.lock) file (recommended) or by building a lock of your own.
To obtain the source code, you can either download the latest version from [Releases](https://github.com/Eutropios/WarMAC/releases) or by cloning the repository using [git](https://git-scm.com/downloads) with the following command:
```bash
git clone https://github.com/Eutropios/WarMAC.git ./some/directory
```
WarMAC can then be built by navigating to the directory you cloned WarMAC into, and running the `poetry build` and `poetry install` commands.
## Usage<a id="usage"></a>
### General Usage
Full usage instructions as well as examples can be found in the [official documentation](https://warmac.readthedocs.io/en/).
WarMAC has a variety of commands for users to select from. Each command has its own unique options and arguments. Wherever possible, options that perform similar functions for different commands will share the same name.
Every WarMAC command is preceded by ``warmac``. The general help section of the program can be viewed by running `warmac --help`.
To view a specific command's usage from the command line, simply run:
`warmac <command> --help`
For example, to view the usage for the average command, users should run:
`warmac average --help`
### Handling WarMAC Output
WarMAC accepts outgoing pipes just like any other tool:
```bash
$ warmac average -p=ps4 -t=5 -v "bite" | grep "Time Range"
Time Range Used: 10 days
```
WarMAC output can also be redirected to a file:
```bash
$ warmac average -p PC -t 2 -v "vengeful revenant" > warmacOut.txt
$ cat warmacOut.txt
Item: Vengeful Revenant
Statistic Found: Median
Time Range Used: 2 days
Median Price: 5.0 platinum
Max Price: 30 platinum
Min Price: 4 platinum
Number of Orders: 38
```
### Examples
Calculating the median price of the mod "Primed Continuity" on PS4. Note that the median is calculated as it's the default.
```bash
warmac average -p ps4 "primed continuity"
```
Calculating the mode price of the mod "Bite" when it's at max rank on PC. Note that the PC price is calculated as it's the default.
```bash
warmac average -s mode -m bite
```
## Documentation<a id="documentation"></a>
Full documentation for installation, usage, and contribution guidelines can be found [here](https://warmac.readthedocs.io/en/).
## Upcoming Features<a id="upcoming-features"></a>
* Adding file input
* Adding even more commands to WarMAC!
## Contributing<a id="contributing"></a>
Contributions are welcome. The expected development stack that you will use consists of `docformatter`, `mypy`, and `ruff`. Please see [`pyproject.toml`](<https://github.com/Eutropios/WarMAC/blob/main/pyproject.toml>) for the appropriate configuration of each tool.
### Testing
There are currently no tests or intrusive GitHub Actions, but that is expected to change in the future.
## Acknowledgements<a id="acknowledgements"></a>
In addition to the tools listed in [`.pre-commit-config.yaml`](https://github.com/Eutropios/WarMAC/blob/main/.pre-commit-config.yaml) and [`pyproject.toml`](https://github.com/Eutropios/WarMAC/blob/main/pyproject.toml), this project uses the following tools in its development:
* [autoDocstring](https://github.com/NilsJPWerner/autoDocstring)
* [Taplo and the Even Better TOML extension](https://github.com/tamasfe/taplo)
* [markdownlint](https://github.com/DavidAnson/vscode-markdownlint)
* [vermin](https://github.com/netromdk/vermin)
WarMAC is packaged using [Poetry](https://github.com/python-poetry/poetry).
## Licensing<a id="licensing"></a>
***This project is NOT affiliated with Warframe, Digital Extremes, or Warframe Market***
Copyright (c) 2023 Noah Jenner under MIT License
*For additional licensing information, please see [`LICENSE.txt`](https://github.com/Eutropios/WarMAC/blob/main/LICENSE.txt)*
*For licensing regarding urllib3, please see [`LICENSE-urllib3.txt`](https://github.com/Eutropios/WarMAC/blob/main/LICENSE-urllib3.txt)*
## Authors
WarMAC is authored by:
* [@eutropios](https://www.github.com/Eutropios)
Raw data
{
"_id": null,
"home_page": "https://github.com/Eutropios/WarMAC",
"name": "WarMAC",
"maintainer": "Noah Jenner",
"docs_url": null,
"requires_python": ">=3.8,<3.13.0",
"maintainer_email": "noah.jenner@proton.me",
"keywords": "platinum,warframe calculator,warframe market,warframe",
"author": "Noah Jenner",
"author_email": "noah.jenner@proton.me",
"download_url": "https://files.pythonhosted.org/packages/73/c5/1ccab3c490d2bb58fe3a075dede8f01d62381728195b5c906c61e862a45f/warmac-0.0.4.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# WarMAC Version 0.0.4\n\n[](https://github.com/Eutropios/WarMAC)\n[](https://warmac.readthedocs.io/en/latest/?badge=latest)\n[](https://results.pre-commit.ci/latest/github/Eutropios/WarMAC/main) \n[](https://pypi.org/project/warmac/)\n[](https://pypi.org/project/warmac/) \n[](https://github.com/astral-sh/ruff)\n[](https://github.com/Eutropios/WarMAC)\n[](https://pypi.org/project/warmac/)\n\n</div>\n\n**WarMAC** is a command-line Python script that can calculate the average market price of items in Warframe.\n\n**WarMAC** compiles orders from the fan website *<https://warframe.market/>* and can be used to find the average prices of prime parts, tradeable parts, relics, mods, and arcane enhancements.\n\n## Features\n\n* \ud83c\udfaeTarget PC, PlayStation, XBOX, or Nintendo Switch platforms.\n* \ud83d\udcc8Calculate the median, mean, mode, harmonic mean, or geometric means of items.\n* \ud83d\udd5cRestrict orders to specific time ranges.\n* \ud83d\udcb0Utilize either seller or buyer orders.\n* \u26cf\ufe0fFind averages for intact or radiant relics.\n* \u2728Find averages for unranked or max-ranked mods and arcane enhancements.\n\n## Table of Contents\n\n* [Installation](#installation)\n* [Usage](#usage)\n* [Documentation](#documentation)\n* [Upcoming Features](#upcoming-features)\n* [Contributing](#contributing)\n* [Acknowledgements](#acknowledgements)\n* [Licensing](#licensing)\n\n## Installation<a id=\"installation\"></a> <!--This ensures PyPI compatibility-->\n\nWarMAC only supports Python versions 3.8 to 3.12. There are currently no plans to add support to Python 3.7\n\n### Using pipx\n\nCurrently, the primary method of installing WarMAC is by installing it through [pipx](https://pypa.github.io/pipx/). This keeps WarMAC and its dependencies separate from your global Python packages. Installation can be done using the following command:\n\n| Platform | Command |\n|---|---|\n| UNIX/MacOS | `python -m pipx install warmac` |\n| Windows | `py -m pipx install warmac` |\n\nYou can ensure that you've installed WarMAC correctly by calling its help page like so:\n\n```bash\nwarmac --version\n```\n\n### Using Pip\n\nUsing pip alone to install WarMAC will work just as well. Installation can be done using the following command:\n\n| Platform | Command |\n|---|---|\n| UNIX/MacOS | `python -m pip install warmac` |\n| Windows | `py -m pip install warmac` |\n\nYou can ensure that you've installed WarMAC correctly by calling its help page like so:\n\n```bash\nwarmac --version\n```\n\n### Using Poetry\n\nWarMAC can also be installed using [Poetry](https://python-poetry.org/) either through the provided [`poetry.lock`](https://github.com/Eutropios/WarMAC/blob/main/poetry.lock) file (recommended) or by building a lock of your own.\n\nTo obtain the source code, you can either download the latest version from [Releases](https://github.com/Eutropios/WarMAC/releases) or by cloning the repository using [git](https://git-scm.com/downloads) with the following command:\n\n```bash\ngit clone https://github.com/Eutropios/WarMAC.git ./some/directory\n```\n\nWarMAC can then be built by navigating to the directory you cloned WarMAC into, and running the `poetry build` and `poetry install` commands.\n\n## Usage<a id=\"usage\"></a>\n\n### General Usage\n\nFull usage instructions as well as examples can be found in the [official documentation](https://warmac.readthedocs.io/en/).\n\nWarMAC has a variety of commands for users to select from. Each command has its own unique options and arguments. Wherever possible, options that perform similar functions for different commands will share the same name.\n\nEvery WarMAC command is preceded by ``warmac``. The general help section of the program can be viewed by running `warmac --help`.\n\nTo view a specific command's usage from the command line, simply run:\n`warmac <command> --help`\n\nFor example, to view the usage for the average command, users should run:\n`warmac average --help`\n\n### Handling WarMAC Output\n\nWarMAC accepts outgoing pipes just like any other tool:\n\n```bash\n$ warmac average -p=ps4 -t=5 -v \"bite\" | grep \"Time Range\"\nTime Range Used: 10 days\n```\n\nWarMAC output can also be redirected to a file:\n\n```bash\n$ warmac average -p PC -t 2 -v \"vengeful revenant\" > warmacOut.txt\n$ cat warmacOut.txt\nItem: Vengeful Revenant\nStatistic Found: Median\nTime Range Used: 2 days\nMedian Price: 5.0 platinum\nMax Price: 30 platinum\nMin Price: 4 platinum\nNumber of Orders: 38\n```\n\n### Examples\n\nCalculating the median price of the mod \"Primed Continuity\" on PS4. Note that the median is calculated as it's the default.\n\n```bash\nwarmac average -p ps4 \"primed continuity\"\n```\n\nCalculating the mode price of the mod \"Bite\" when it's at max rank on PC. Note that the PC price is calculated as it's the default.\n\n```bash\nwarmac average -s mode -m bite\n```\n\n## Documentation<a id=\"documentation\"></a>\n\nFull documentation for installation, usage, and contribution guidelines can be found [here](https://warmac.readthedocs.io/en/).\n\n## Upcoming Features<a id=\"upcoming-features\"></a>\n\n* Adding file input\n* Adding even more commands to WarMAC!\n\n## Contributing<a id=\"contributing\"></a>\n\nContributions are welcome. The expected development stack that you will use consists of `docformatter`, `mypy`, and `ruff`. Please see [`pyproject.toml`](<https://github.com/Eutropios/WarMAC/blob/main/pyproject.toml>) for the appropriate configuration of each tool.\n\n### Testing\n\nThere are currently no tests or intrusive GitHub Actions, but that is expected to change in the future.\n\n## Acknowledgements<a id=\"acknowledgements\"></a>\n\nIn addition to the tools listed in [`.pre-commit-config.yaml`](https://github.com/Eutropios/WarMAC/blob/main/.pre-commit-config.yaml) and [`pyproject.toml`](https://github.com/Eutropios/WarMAC/blob/main/pyproject.toml), this project uses the following tools in its development:\n\n* [autoDocstring](https://github.com/NilsJPWerner/autoDocstring)\n* [Taplo and the Even Better TOML extension](https://github.com/tamasfe/taplo)\n* [markdownlint](https://github.com/DavidAnson/vscode-markdownlint)\n* [vermin](https://github.com/netromdk/vermin)\n\nWarMAC is packaged using [Poetry](https://github.com/python-poetry/poetry).\n\n## Licensing<a id=\"licensing\"></a>\n\n***This project is NOT affiliated with Warframe, Digital Extremes, or Warframe Market***\n\nCopyright (c) 2023 Noah Jenner under MIT License\n\n*For additional licensing information, please see [`LICENSE.txt`](https://github.com/Eutropios/WarMAC/blob/main/LICENSE.txt)* \n*For licensing regarding urllib3, please see [`LICENSE-urllib3.txt`](https://github.com/Eutropios/WarMAC/blob/main/LICENSE-urllib3.txt)*\n\n## Authors\n\nWarMAC is authored by:\n\n* [@eutropios](https://www.github.com/Eutropios)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An average platinum price calculator for tradeable items in Warframe.",
"version": "0.0.4",
"project_urls": {
"Bug Tracker": "https://github.com/Eutropios/WarMAC/issues",
"Documentation": "https://warmac.readthedocs.io/en/",
"Homepage": "https://github.com/Eutropios/WarMAC",
"Repository": "https://github.com/Eutropios/WarMAC"
},
"split_keywords": [
"platinum",
"warframe calculator",
"warframe market",
"warframe"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2351ac9a8d00189a612259d9c2f709858960a8b631447304d88233ba1b740bd4",
"md5": "81251a45b52243741798657e2367cb1c",
"sha256": "42913aea704446e19f93890add55335d94dbf241e2e3af768a54fe4476ba0792"
},
"downloads": -1,
"filename": "warmac-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81251a45b52243741798657e2367cb1c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.13.0",
"size": 16265,
"upload_time": "2023-12-22T01:39:56",
"upload_time_iso_8601": "2023-12-22T01:39:56.191743Z",
"url": "https://files.pythonhosted.org/packages/23/51/ac9a8d00189a612259d9c2f709858960a8b631447304d88233ba1b740bd4/warmac-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "73c51ccab3c490d2bb58fe3a075dede8f01d62381728195b5c906c61e862a45f",
"md5": "c54b0bda272c0d0255ef724e258fb67a",
"sha256": "333bab01ef493426edb00bb71de29ae1a80f08e64328b51a52d1cd56e7ffeec1"
},
"downloads": -1,
"filename": "warmac-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "c54b0bda272c0d0255ef724e258fb67a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.13.0",
"size": 17043,
"upload_time": "2023-12-22T01:39:57",
"upload_time_iso_8601": "2023-12-22T01:39:57.372204Z",
"url": "https://files.pythonhosted.org/packages/73/c5/1ccab3c490d2bb58fe3a075dede8f01d62381728195b5c906c61e862a45f/warmac-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-22 01:39:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Eutropios",
"github_project": "WarMAC",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "warmac"
}
JSON
