Skip to main content

A web application that lets you view YGOJSON data.

Project description

YJViewer

YJViewer's front page. YJViewer searching for cards. YJViewer at a card page.

A web application that lets you view YGOJSON data.

Running Locally

You'll need a modern version of Python, at least 3.8, to run this code. To install YJViewer from PyPI:

python3 -m pip install yjviewer

Or to install it if you have the repository downloaded:

python3 -m pip install -e .

From there, you can run this application using flask:

flask --app yjviewer --debug run

It should then load the database and give you a URL to connect to (by default, http://localhost:5000/).

If you don't have the database downloaded, it will download it for you, but it will NOT automatically update an outdated database. You will have to either delete data or redownload it yourself, if you want an updated dataset!

Running in Production

Short answer: Don't.

Long answer: This is a web application meant to be accessed by one person: you. I have not created this with scalability in mind. If you try to serve this to a network, expect problems if you get a lot of people accessing it. Furthermore, we do not cache the images we get from cross-site sources, such as Yugipedia or YGOPRODECK, and those sites have strict policies about hotlinking images from them. If you expose a YJViewer server to the outer world, expect those two sites to get mad at you if you're popular enough. I don't have the money to set up a YJViewer server myself, and even if I did solve the image-hotlinking problem, I don't know if I would have the time to maintain such a website. So don't use this in production, and don't ask me to use this in production. Saying that, if you do want to help me make YJViewer production-ready, see Contributing, below.

Contributing

PRs are always welcome! To set up YJViewer for development, follow these steps after checking out the repository:

python3 -m pip install -e .[dev,test]
pre-commit install

Changelog

0.2.2

  • Fixed bug with the random sealed product button.

0.2.1

  • Removed deprecated use of boxImage property.

0.2.0

  • Added support for viewing sealed products.
  • Added support for viewing set pack distributions.

0.1.1

  • Fix image loading.
  • Add filtering to card printing display.

0.1.0

Initial version.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yjviewer-0.2.2.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

yjviewer-0.2.2-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file yjviewer-0.2.2.tar.gz.

File metadata

  • Download URL: yjviewer-0.2.2.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for yjviewer-0.2.2.tar.gz
Algorithm Hash digest
SHA256 e48155a6a3ea8a27210c347165db0f845ddb3413d010581303f343aaff8a013f
MD5 33cadd78e9cc2fa78aeafdba5429ae6d
BLAKE2b-256 bf4fbb1b184ea0d55ba59e447a038b21d6700a7e88c5b49a9093a7fa1f5e1e50

See more details on using hashes here.

File details

Details for the file yjviewer-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: yjviewer-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for yjviewer-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f5509048437f7151bd297a0db22275f2270f76b880b5e5bf89c199139c107ac8
MD5 72ddec938b4c110ae7ae55a56c091da3
BLAKE2b-256 8ad5cc20feb5af8bfb0c51b461d9c091fc64ff135c714f47d85cf3db79816778

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page