Skip to main content

A streamlit custom component for doubutsushogi (animal chess) game

Project description

streamlit-doubutsushogi

Open in Streamlit

A streamlit custom component for interactive board of doubutsushogi (animal chess) game.

Install

# from pypi
pip3 install streamlit-doubutsushogi

# or from github
# see also the streamlit component API manual (https://docs.streamlit.io/library/components/components-api)
git clone https://github.com/kota7/streamlit-doubutsushogi.git
cd streamlit-doubutsushogi/streamlit_doubutsushogi/frontend
npm run build
pip3 install -U ../../

Usage

See the minimal example at example.py:

import streamlit as st
from streamlit_doubutsushogi import st_doubutsushogi

c1, c2 = st.columns([6, 6])
with c1:
    state, status, action = st_doubutsushogi()

if status != 0:
    c2.write(f"Game over! Won by the player {status}")

Run the script by:

streamlit run example.py

example.gif

Doubutsu Shogi Master App

An interactive app is deployed on the Streamlit Cloud. To run the app on the computer locally, run the following:

streamlit run app/streamlit_app.py

Tips

How to upload this app to PyPI

# 1. build javascript sources
cd streamlit_doubutsushogi/frontend && npm run build && cd ../../
# 2. make python package wheel
rm -r build dist *.egg-info   # only for the second time or later
python3 setup.py sdist bdist_wheel
# 3. upload to PyPI
twine upload --repository pypi dist/*
  1. Build the javascript application
  2. Make Python package wheel
  3. Upload to PyPI

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

streamlit-doubutsushogi-0.0.18.tar.gz (716.5 kB view hashes)

Uploaded Source

Built Distribution

streamlit_doubutsushogi-0.0.18-py3-none-any.whl (722.4 kB view hashes)

Uploaded Python 3

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