.. role:: bash(code)
:language: bash
**************
Discord Dumper
**************
|ci-docs| |ci-lint| |ci-tests| |pypi| |versions| |discord| |license|
.. |ci-docs| image:: https://github.com/Dashstrom/discord-dumper/actions/workflows/docs.yml/badge.svg
:target: https://github.com/Dashstrom/discord-dumper/actions/workflows/docs.yml
:alt: CI : Docs
.. |ci-lint| image:: https://github.com/Dashstrom/discord-dumper/actions/workflows/lint.yml/badge.svg
:target: https://github.com/Dashstrom/discord-dumper/actions/workflows/lint.yml
:alt: CI : Lint
.. |ci-tests| image:: https://github.com/Dashstrom/discord-dumper/actions/workflows/tests.yml/badge.svg
:target: https://github.com/Dashstrom/discord-dumper/actions/workflows/tests.yml
:alt: CI : Tests
.. |pypi| image:: https://img.shields.io/pypi/v/discord-dumper.svg
:target: https://pypi.org/project/discord-dumper
:alt: PyPI : discord-dumper
.. |versions| image:: https://img.shields.io/pypi/pyversions/discord-dumper.svg
:target: https://pypi.org/project/discord-dumper
:alt: Python : versions
.. |discord| image:: https://img.shields.io/badge/Discord-dashstrom-5865F2?style=flat&logo=discord&logoColor=white
:target: https://dsc.gg/dashstrom
:alt: Discord
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
:target: https://github.com/Dashstrom/discord-dumper/blob/main/LICENSE
:alt: License : MIT
Description
###########
Retrieve all your discord information using a HAR file.
Documentation
#############
Documentation is available on https://dashstrom.github.io/discord-dumper
Installation
############
You can install :bash:`discord-dumper` using `pipx <https://pipx.pypa.io/stable/>`_
from `PyPI <https://pypi.org/project>`_
.. code-block:: bash
pip install pipx
pipx ensurepath
pipx install discord-dumper
How to get an HAR File ?
########################
1. Go on your favorite browser
2. Press F12
3. Go to Network tab
4. Check Disable cache
5. Check Preserve log
6. Go on discord.com and where you want to collect data
7. Right-click on an event in the Network tab
8. Save all as HAR with content
Usage
#####
.. code-block:: bash
discord-dumper --help
discord-dumper discord.com.har --fetch
Dump content
############
- :bash:`events.json`: All events sended and receive by your applications
- :bash:`images`: All images downloaded from :bash:`cdn.discordapp.com`
- :bash:`guilds`: Partial guild content
- :bash:`private_channels`: Partial private channels
- :bash:`connected_accounts`: All your connected accounts
- :bash:`user`: Some users
Development
###########
Contributing
************
Contributions are very welcome. Tests can be run with :bash:`poe check`, please
ensure the coverage at least stays the same before you submit a pull request.
Setup
*****
You need to install `Poetry <https://python-poetry.org/docs/#installation>`_
and `Git <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_
for work with this project.
.. code-block:: bash
git clone https://github.com/Dashstrom/discord-dumper
cd discord-dumper
poetry install --all-extras
poetry run poe setup
poetry shell
Poe
********
Poe is available for help you to run tasks.
.. code-block:: text
test Run test suite.
lint Run linters: ruff linter, ruff formatter and mypy.
format Run linters in fix mode.
check Run all checks: lint, test and docs.
cov Run coverage for generate report and html.
open-cov Open html coverage report in webbrowser.
docs Build documentation.
open-docs Open documentation in webbrowser.
setup Setup pre-commit.
pre-commit Run pre-commit.
clean Clean cache files
Skip commit verification
************************
If the linting is not successful, you can't commit.
For forcing the commit you can use the next command :
.. code-block:: bash
git commit --no-verify -m 'MESSAGE'
Commit with commitizen
**********************
To respect commit conventions, this repository uses
`Commitizen <https://github.com/commitizen-tools/commitizen?tab=readme-ov-file>`_.
.. code-block:: bash
cz c
How to add dependency
*********************
.. code-block:: bash
poetry add 'PACKAGE'
Ignore illegitimate warnings
****************************
To ignore illegitimate warnings you can add :
- **# noqa: ERROR_CODE** on the same line for ruff.
- **# type: ignore[ERROR_CODE]** on the same line for mypy.
- **# pragma: no cover** on the same line to ignore line for coverage.
- **# doctest: +SKIP** on the same line for doctest.
Uninstall
#########
.. code-block:: bash
pipx uninstall discord-dumper
License
#######
This work is licensed under `MIT <https://github.com/Dashstrom/discord-dumper/blob/main/LICENSE>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/Dashstrom/discord-dumper",
"name": "discord-dumper",
"maintainer": "Dashstrom",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "dashstrom.pro@gmail.com",
"keywords": "python",
"author": "Dashstrom",
"author_email": "dashstrom.pro@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5c/91/f50da4164c96af9aee4121e748262a7e95cdd8f737f485f931c15b6155e4/discord_dumper-0.0.1.tar.gz",
"platform": null,
"description": ".. role:: bash(code)\n :language: bash\n\n**************\nDiscord Dumper\n**************\n\n|ci-docs| |ci-lint| |ci-tests| |pypi| |versions| |discord| |license|\n\n.. |ci-docs| image:: https://github.com/Dashstrom/discord-dumper/actions/workflows/docs.yml/badge.svg\n :target: https://github.com/Dashstrom/discord-dumper/actions/workflows/docs.yml\n :alt: CI : Docs\n\n.. |ci-lint| image:: https://github.com/Dashstrom/discord-dumper/actions/workflows/lint.yml/badge.svg\n :target: https://github.com/Dashstrom/discord-dumper/actions/workflows/lint.yml\n :alt: CI : Lint\n\n.. |ci-tests| image:: https://github.com/Dashstrom/discord-dumper/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/Dashstrom/discord-dumper/actions/workflows/tests.yml\n :alt: CI : Tests\n\n.. |pypi| image:: https://img.shields.io/pypi/v/discord-dumper.svg\n :target: https://pypi.org/project/discord-dumper\n :alt: PyPI : discord-dumper\n\n.. |versions| image:: https://img.shields.io/pypi/pyversions/discord-dumper.svg\n :target: https://pypi.org/project/discord-dumper\n :alt: Python : versions\n\n.. |discord| image:: https://img.shields.io/badge/Discord-dashstrom-5865F2?style=flat&logo=discord&logoColor=white\n :target: https://dsc.gg/dashstrom\n :alt: Discord\n\n.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg\n :target: https://github.com/Dashstrom/discord-dumper/blob/main/LICENSE\n :alt: License : MIT\n\nDescription\n###########\n\nRetrieve all your discord information using a HAR file.\n\nDocumentation\n#############\n\nDocumentation is available on https://dashstrom.github.io/discord-dumper\n\nInstallation\n############\n\nYou can install :bash:`discord-dumper` using `pipx <https://pipx.pypa.io/stable/>`_\nfrom `PyPI <https://pypi.org/project>`_\n\n.. code-block:: bash\n\n pip install pipx\n pipx ensurepath\n pipx install discord-dumper\n\nHow to get an HAR File ?\n########################\n\n1. Go on your favorite browser\n2. Press F12\n3. Go to Network tab\n4. Check Disable cache\n5. Check Preserve log\n6. Go on discord.com and where you want to collect data\n7. Right-click on an event in the Network tab\n8. Save all as HAR with content\n\nUsage\n#####\n\n.. code-block:: bash\n\n discord-dumper --help\n discord-dumper discord.com.har --fetch\n\nDump content\n############\n\n- :bash:`events.json`: All events sended and receive by your applications\n- :bash:`images`: All images downloaded from :bash:`cdn.discordapp.com`\n- :bash:`guilds`: Partial guild content\n- :bash:`private_channels`: Partial private channels\n- :bash:`connected_accounts`: All your connected accounts\n- :bash:`user`: Some users\n\nDevelopment\n###########\n\nContributing\n************\n\nContributions are very welcome. Tests can be run with :bash:`poe check`, please\nensure the coverage at least stays the same before you submit a pull request.\n\nSetup\n*****\n\nYou need to install `Poetry <https://python-poetry.org/docs/#installation>`_\nand `Git <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_\nfor work with this project.\n\n.. code-block:: bash\n\n git clone https://github.com/Dashstrom/discord-dumper\n cd discord-dumper\n poetry install --all-extras\n poetry run poe setup\n poetry shell\n\nPoe\n********\n\nPoe is available for help you to run tasks.\n\n.. code-block:: text\n\n test Run test suite.\n lint Run linters: ruff linter, ruff formatter and mypy.\n format Run linters in fix mode.\n check Run all checks: lint, test and docs.\n cov Run coverage for generate report and html.\n open-cov Open html coverage report in webbrowser.\n docs Build documentation.\n open-docs Open documentation in webbrowser.\n setup Setup pre-commit.\n pre-commit Run pre-commit.\n clean Clean cache files\n\nSkip commit verification\n************************\n\nIf the linting is not successful, you can't commit.\nFor forcing the commit you can use the next command :\n\n.. code-block:: bash\n\n git commit --no-verify -m 'MESSAGE'\n\nCommit with commitizen\n**********************\n\nTo respect commit conventions, this repository uses\n`Commitizen <https://github.com/commitizen-tools/commitizen?tab=readme-ov-file>`_.\n\n.. code-block:: bash\n\n cz c\n\nHow to add dependency\n*********************\n\n.. code-block:: bash\n\n poetry add 'PACKAGE'\n\nIgnore illegitimate warnings\n****************************\n\nTo ignore illegitimate warnings you can add :\n\n- **# noqa: ERROR_CODE** on the same line for ruff.\n- **# type: ignore[ERROR_CODE]** on the same line for mypy.\n- **# pragma: no cover** on the same line to ignore line for coverage.\n- **# doctest: +SKIP** on the same line for doctest.\n\nUninstall\n#########\n\n.. code-block:: bash\n\n pipx uninstall discord-dumper\n\nLicense\n#######\n\nThis work is licensed under `MIT <https://github.com/Dashstrom/discord-dumper/blob/main/LICENSE>`_.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Retrieve all your discord information using a HAR file.",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://dashstrom.github.io/discord-dumper",
"Homepage": "https://github.com/Dashstrom/discord-dumper",
"Repository": "https://github.com/Dashstrom/discord-dumper"
},
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c38bf5b02f128daae895310e7025b1bc1d606b80b7c9e9743f2cbf344eb3761a",
"md5": "6365d02d5084ae0c2ea0430aac2f61d3",
"sha256": "d89fcc157e42118ac0c0c07af5dcec4c7e8dd2b153897fe27bd21987456f0c35"
},
"downloads": -1,
"filename": "discord_dumper-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6365d02d5084ae0c2ea0430aac2f61d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8975,
"upload_time": "2024-07-21T08:48:23",
"upload_time_iso_8601": "2024-07-21T08:48:23.141543Z",
"url": "https://files.pythonhosted.org/packages/c3/8b/f5b02f128daae895310e7025b1bc1d606b80b7c9e9743f2cbf344eb3761a/discord_dumper-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c91f50da4164c96af9aee4121e748262a7e95cdd8f737f485f931c15b6155e4",
"md5": "9f3c8526f439d82a96a2b05f6edef5ce",
"sha256": "93aea70146d63684eeeec2ed093e8bb0ddece99165b6ca1cdf267f387b656eda"
},
"downloads": -1,
"filename": "discord_dumper-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9f3c8526f439d82a96a2b05f6edef5ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11141,
"upload_time": "2024-07-21T08:48:24",
"upload_time_iso_8601": "2024-07-21T08:48:24.647003Z",
"url": "https://files.pythonhosted.org/packages/5c/91/f50da4164c96af9aee4121e748262a7e95cdd8f737f485f931c15b6155e4/discord_dumper-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-21 08:48:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Dashstrom",
"github_project": "discord-dumper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "discord-dumper"
}
JSON
