fullcalendar.io component for Dash
Project description
Full Calendar Component
Full Calendar Component is a Dash component library.
Large interactive full calendar component for dash to create and track events.
Get started with:
- Install Dash and its dependencies: https://dash.plotly.com/installation
- Run
python usage.py
- 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.
-
Install npm packages
$ npm install
-
Create a virtual env and activate.
$ virtualenv venv $ . venv/bin/activate
Note: venv\Scripts\activate for windows
-
Install python packages required to build components.
$ pip install -r requirements.txt
-
Install the python packages for testing (optional)
$ pip install -r tests/requirements.txt
Write your component code in src/lib/components/FullCalendarComponent.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:
- Build your code
$ npm run build
- Run and modify the
usage.py
sample dash app:$ python usage.py
- Build your code
- Write tests for your component.
- A sample test is available in
tests/test_usage.py
, it will loadusage.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)
- A sample test is available in
- Add custom styles to your component by putting your custom CSS files into your distribution folder (
full_calendar_component
).- 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 infull_calendar_component/__init__.py
so dash will serve them automatically when the component suite is requested.
- Make sure that they are referenced in
- Review your code
Create a production build and publish:
-
Build your code:
$ npm run build
-
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. -
Test your tarball by copying it into a new environment and installing it locally:
$ pip install full_calendar_component-0.0.1.tar.gz
-
If it works, then you can publish the component to NPM and PyPI:
- Publish on PyPI
$ twine upload dist/*
- Cleanup the dist folder (optional)
$ rm -rf dist
- Publish on NPM (Optional if chosen False in
publish_on_npm
)
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$ npm publish
serve_locally
toFalse
and you may see faster load times.
- Publish on PyPI
-
Share your component with the community! https://community.plotly.com/c/dash
- Publish this repository to GitHub
- Tag your GitHub repository with the plotly-dash tag so that it appears here: https://github.com/topics/plotly-dash
- 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
Built Distribution
Hashes for full_calendar_component-0.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bfae49627c2aec546203a8aeb6b4f931e006ee6d5f5d38baa5f45aed3c47595 |
|
MD5 | 525e59c93c6d36e23b3fc8c76afe3710 |
|
BLAKE2b-256 | 409e9b3f5aa2024b938793b33d39a13451198559b7ccc1571802941eedbf6252 |
Hashes for full_calendar_component-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20d11fcb472041883962e454bcc87ad29d70051cc6d94a5d8c134d4626120b72 |
|
MD5 | ad0bc833db221126d97a3f7c0fb6eace |
|
BLAKE2b-256 | 7349d7fe610d9878937d1a3afc858274aeab81b96511155b233a8bc106a2f328 |