Skip to main content

swiper for dash

Project description

dash_swiper

dash_swiper is a Dash component library.

swiper for dash

Get started with:

  1. Install Dash and its dependencies: https://dash.plotly.com/installation
  2. Run python usage.py
  3. Visit http://localhost:8050 in your web browser

Contributing

See CONTRIBUTING.md

Install dependencies

If you have selected install_dependencies during the prompt, you can skip this part.

  1. Install npm packages

    $ npm install
    
  2. Create a virtual env and activate.

    $ virtualenv venv
    $ . venv/bin/activate
    

    Note: venv\Scripts\activate for windows

  3. Install python packages required to build components.

    $ pip install -r requirements.txt
    
  4. Install the python packages for testing (optional)

    $ pip install -r tests/requirements.txt
    

Write your component code in src/lib/components/DashSwiper.react.js.

  • The demo app is in src/demo and you will import your example component code into your demo app.
  • Test your code in a Python environment:
    1. Build your code
      $ npm run build
      
    2. Run and modify the usage.py sample dash app:
      $ python usage.py
      
  • Write tests for your component.
    • A sample test is available in tests/test_usage.py, it will load usage.py and you can then automate interactions with selenium.
    • Run the tests with $ pytest tests.
    • The Dash team uses these types of integration tests extensively. Browse the Dash component code on GitHub for more examples of testing (e.g. https://github.com/plotly/dash-core-components)
  • Add custom styles to your component by putting your custom CSS files into your distribution folder (dash_swiper).
    • Make sure that they are referenced in MANIFEST.in so that they get properly included when you're ready to publish your component.
    • Make sure the stylesheets are added to the _css_dist dict in dash_swiper/__init__.py so dash will serve them automatically when the component suite is requested.
  • Review your code

Create a production build and publish:

  1. Build your code:

    $ npm run build
    
  2. Create a Python distribution

    $ python setup.py sdist bdist_wheel
    

    This will create source and wheel distribution in the generated the dist/ folder. See PyPA for more information.

  3. Test your tarball by copying it into a new environment and installing it locally:

    $ pip install dash_swiper-0.0.1.tar.gz
    
  4. If it works, then you can publish the component to NPM and PyPI:

    1. Publish on PyPI
      $ twine upload dist/*
      
    2. Cleanup the dist folder (optional)
      $ rm -rf dist
      
    3. Publish on NPM (Optional if chosen False in publish_on_npm)
      $ npm publish
      
      Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash serves the component library's CSS and JS locally, but if you choose to publish the package to NPM you can set serve_locally to False and you may see faster load times.
  5. Share your component with the community! https://community.plotly.com/c/dash

    1. Publish this repository to GitHub
    2. Tag your GitHub repository with the plotly-dash tag so that it appears here: https://github.com/topics/plotly-dash
    3. Create a post in the Dash community forum: https://community.plotly.com/c/dash

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

dash_swiper-0.0.3.tar.gz (269.4 kB view details)

Uploaded Source

Built Distribution

dash_swiper-0.0.3-py3-none-any.whl (272.8 kB view details)

Uploaded Python 3

File details

Details for the file dash_swiper-0.0.3.tar.gz.

File metadata

  • Download URL: dash_swiper-0.0.3.tar.gz
  • Upload date:
  • Size: 269.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.6

File hashes

Hashes for dash_swiper-0.0.3.tar.gz
Algorithm Hash digest
SHA256 b598738e4dd3150ebf47a07d826e2bc593ea669ae7b33f591e83e7ec33952c30
MD5 c9ae390350cae1c4861df58d9c01f368
BLAKE2b-256 64e8098d820b33fc6951ee4594b0b6cc8a4c64255581aab5fd0dae2b21d61cf7

See more details on using hashes here.

File details

Details for the file dash_swiper-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: dash_swiper-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 272.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.6

File hashes

Hashes for dash_swiper-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f4e0c3ca3d0d6c2eada22f9e289c3625cfa12b637789334a4c80e701c96bd0ac
MD5 5bca97be61941cf59241d310820e9b46
BLAKE2b-256 cbf96377fa68f7df7b1192b5858f57a256c353f4cb16d59c095450a5abfe6a1a

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