From 62474a067347d5ad88b379c6be84593c2b3e2b5d Mon Sep 17 00:00:00 2001
From: A Nova <32076287+fox-techniques@users.noreply.github.com>
Date: Tue, 5 Nov 2024 12:00:46 +0100
Subject: [PATCH] [docs] Updated Docs with community health files
---
README.md | 2 +-
docs/CODE_OF_CONDUCT.md | 128 ++++++++++++++++++++++++
docs/CONTRIBUTING.md | 166 ++++++++++++++++++++++++++++++++
docs/CREDITS.md | 7 ++
docs/{license.md => LICENSE.md} | 2 +-
docs/SECURITY.md | 16 +++
docs/SUPPORT.md | 31 ++++++
docs/demo.md | 88 ++++++++++-------
docs/index.md | 2 +-
docs/installation.md | 44 ++++++++-
mkdocs.yml | 9 +-
11 files changed, 451 insertions(+), 44 deletions(-)
create mode 100644 docs/CODE_OF_CONDUCT.md
create mode 100644 docs/CONTRIBUTING.md
create mode 100644 docs/CREDITS.md
rename docs/{license.md => LICENSE.md} (96%)
create mode 100644 docs/SECURITY.md
create mode 100644 docs/SUPPORT.md
diff --git a/README.md b/README.md
index 7e8369e..19b9e7e 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
Irene-Sankey is a Python library that enables the creation of customizable and informative source-target pair to create Sankey diagrams. It is designed to be intuitive for both beginners and experts, with flexible options for styling, data input, and configuration, making it easy to represent complex flows visually.
-[](https://pypi.org/project/irene-senkey/)
+[](https://pypi.org/project/irene-sankey/)
[](https://pypi.org/project/irene-sankey/)
[](https://github.com/fox-techniques/irene-sankey/blob/main/LICENSE)
[](https://github.com/fox-techniques/irene-sankey)
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..f887a33
--- /dev/null
+++ b/docs/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+ overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+ address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
\ No newline at end of file
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
new file mode 100644
index 0000000..54a1a01
--- /dev/null
+++ b/docs/CONTRIBUTING.md
@@ -0,0 +1,166 @@
+# Contributing Guidelines
+
+*Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!*
+
+> **This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.**
+
+## :book: Code of Conduct
+
+Please review our [Code of Conduct](CODE_OF_CONDUCT.md)[^1]. It is in effect at all times. We expect it to be honored by everyone who contributes to this project. Acting like an asshole will not be tolerated.
+
+[^1]: [Code of Conduct](https://github.com/fox-techniques/irene-sankey/blob/main/docs/CODE_OF_CONDUCT.md) page on Github.
+
+## :bulb: Asking Questions
+
+See our [Support Guide](SUPPORT.md)[^2]. In short, GitHub issues are not the appropriate place to debug your specific project, but should be reserved for filing bugs and feature requests.
+
+[^2]: [Support](https://github.com/fox-techniques/irene-sankey/blob/main/docs/SUPPORT.md) page on Github.
+
+## :inbox_tray: Opening an Issue
+
+Before [creating an issue](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue), check if you are using the latest version of the project. If you are not up-to-date, see if updating fixes your issue first.
+
+### :lock: Reporting Security Issues
+
+Review our [Security Policy](SECURITY.md)[^3]. **Do not** file a public issue for security vulnerabilities.
+
+[^3]: [Security](https://github.com/fox-techniques/irene-sankey/blob/main/docs/SECURITY.md) page on Github.
+
+### :beetle: Bug Reports and Other Issues
+
+A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report. :v:
+
+In short, since you are most likely a developer, **provide a ticket that you would like to receive**.
+
+- **Review the documentation and [Support Guide](SUPPORT.md)[^2]** before opening a new issue.
+
+- **Do not open a duplicate issue!** Search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have. You may simply note "I have this problem too", which helps prioritize the most common problems and requests.
+
+- **Prefer using [reactions](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)**, not comments, if you simply want to "+1" an existing issue.
+
+- **Fully complete the provided issue template.** The bug report template requests all the information we need to quickly and efficiently address your issue. Be clear, concise, and descriptive. Provide as much information as you can, including steps to reproduce, stack traces, compiler errors, library versions, OS versions, and screenshots (if applicable).
+
+- **Use [GitHub-flavored Markdown](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).** Especially put code blocks and console outputs in backticks (```). This improves readability.
+
+## :love_letter: Feature Requests
+
+Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted. We want to avoid [feature creep](https://en.wikipedia.org/wiki/Feature_creep). Your idea may be great, but also out-of-scope for the project. If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are welcome to submit a pull request to help!
+
+- **Do not open a duplicate feature request.** Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue.
+
+- **Fully complete the provided issue template.** The feature request template asks for all necessary information for us to begin a productive conversation.
+
+- Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible.
+
+## :mag: Triaging Issues
+
+You can triage issues which may include reproducing bug reports or asking for additional information, such as version numbers or reproduction instructions. Any help you can provide to quickly resolve an issue is very much appreciated!
+
+## :repeat: Submitting Pull Requests
+
+We **love** pull requests! Before [forking the repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) for non-trivial changes, it is usually best to first open an issue to discuss the changes, or discuss your intended approach for solving the problem in the comments for an existing issue.
+
+For most contributions, after your first pull request is accepted and merged, you will be [invited to the project](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository) and given **push access**. :tada:
+
+*Note: All contributions will be licensed under the project's license.*
+
+- **Smaller is better.** Submit **one** pull request per bug fix or feature. A pull request should contain isolated changes pertaining to a single bug fix or feature implementation. **Do not** refactor or reformat code that is unrelated to your change. It is better to **submit many small pull requests** rather than a single large one. Enormous pull requests will take enormous amounts of time to review, or may be rejected altogether.
+
+- **Coordinate bigger changes.** For large and non-trivial changes, open an issue to discuss a strategy with the maintainers. Otherwise, you risk doing a lot of work for nothing!
+
+- **Prioritize understanding over cleverness.** Write code clearly and concisely. Remember that source code usually gets written once and read often. Ensure the code is clear to the reader. The purpose and logic should be obvious to a reasonably skilled developer, otherwise you should add a comment that explains it.
+
+- **Follow existing coding style and conventions.** Keep your code consistent with the style, formatting, and conventions in the rest of the code base. When possible, these will be enforced with a linter. Consistency makes it easier to review and modify in the future.
+
+- **Include test coverage.** Add unit tests or UI tests when possible. Follow existing patterns for implementing tests.
+
+- **Update the example project** if one exists to exercise any new functionality you have added.
+
+- **Add documentation.** Document your changes with code doc comments or in existing guides.
+
+- **Update the CHANGELOG** for all enhancements and bug fixes. Include the corresponding issue number if one exists, and your GitHub username. (example: "- Fixed crash in profile view. #123 @jessesquires")
+
+- **Use the repo's default branch.** Branch from and [submit your pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to the repo's default branch. Irene-sankey's default branch is `main`.
+
+- **[Resolve any merge conflicts](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)** that occur.
+
+- **Promptly address any CI failures**. If your pull request fails to build or pass tests, please push another commit to fix it.
+
+- When writing comments, use properly constructed sentences, including punctuation.
+
+- Use spaces, not tabs.
+
+## :memo: Writing Commit Messages
+
+Please [write a great commit message](https://chris.beams.io/posts/git-commit/).
+
+1. Separate subject from body with a blank line
+1. Limit the subject line to 50 characters
+1. Capitalize the subject line
+1. Do not end the subject line with a period
+1. Use the imperative mood in the subject line (example: "Fix networking issue")
+1. Wrap the body at about 72 characters
+1. Use the body to explain **why**, *not what and how* (the code shows that!)
+1. If applicable, prefix the title with the relevant component name. (examples: "[docs] Fix typo", "[plots] Fix color theme reference")
+
+```
+[TAG] Short summary of changes in 50 chars or less
+
+Add a more detailed explanation here, if necessary. Possibly give
+some background about the issue being fixed, etc. The body of the
+commit message can be several paragraphs. Further paragraphs come
+after blank lines and please do proper word-wrap.
+
+Wrap it to about 72 characters or so. In some contexts,
+the first line is treated as the subject of the commit and the
+rest of the text as the body. The blank line separating the summary
+from the body is critical (unless you omit the body entirely);
+various tools like `log`, `shortlog` and `rebase` can get confused
+if you run the two together.
+
+Explain the problem that this commit is solving. Focus on why you
+are making this change as opposed to how or what. The code explains
+how or what. Reviewers and your future self can read the patch,
+but might not understand why a particular solution was implemented.
+Are there side effects or other unintuitive consequences of this
+change? Here's the place to explain them.
+
+ - Bullet points are okay, too
+
+ - A hyphen or asterisk should be used for the bullet, preceded
+ by a single space, with blank lines in between
+
+Note the fixed or relevant GitHub issues at the end:
+
+Resolves: #123
+See also: #456, #789
+```
+
+## :white_check_mark: Code Review
+
+- **Review the code, not the author.** Look for and suggest improvements without disparaging or insulting the author. Provide actionable feedback and explain your reasoning.
+
+- **You are not your code.** When your code is critiqued, questioned, or constructively criticized, remember that you are not your code. Do not take code review personally.
+
+- **Always do your best.** No one writes bugs on purpose. Do your best, and learn from your mistakes.
+
+- Kindly note any violations to the guidelines specified in this document.
+
+## :nail_care: Coding Style
+
+Consistency is the most important. Following the existing style, formatting, and naming conventions of the file you are modifying and of the overall project. Failure to do so will result in a prolonged review process that has to focus on updating the superficial aspects of your code, rather than improving its functionality and performance.
+
+For example, if all private properties are prefixed with an underscore `_`, then new ones you add should be prefixed in the same way. Or, if methods are named using camelcase, like `thisIsMyNewMethod`, then do not diverge from that by writing `this_is_my_new_method`. You get the idea. If in doubt, please ask or search the codebase for something similar.
+
+When possible, style and format will be enforced with a linter.
+
+## :medal: Certificate of Origin
+
+*Developer's Certificate of Origin 1.1*
+
+By making a contribution to this project, I certify that:
+
+> 1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
+> 1. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
+> 1. The contribution was provided directly to me by some other person who certified (1), (2) or (3) and I have not modified it.
+> 1. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
diff --git a/docs/CREDITS.md b/docs/CREDITS.md
new file mode 100644
index 0000000..006678e
--- /dev/null
+++ b/docs/CREDITS.md
@@ -0,0 +1,7 @@
+# Credits
+
+Special thanks to:
+
+- [Mike Bostock](https://observablehq.com/@mbostock)
+- [Yan Holtz](https://www.yan-holtz.com/)
+- [Jesse Squires](https://github.com/jessesquires)
diff --git a/docs/license.md b/docs/LICENSE.md
similarity index 96%
rename from docs/license.md
rename to docs/LICENSE.md
index e58cbd3..1977fd3 100644
--- a/docs/license.md
+++ b/docs/LICENSE.md
@@ -2,7 +2,7 @@
**MIT License**
-Copyright (c) 2024 Fox-Techniques
+Copyright (c) 2024 Fox Techniques
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/docs/SECURITY.md b/docs/SECURITY.md
new file mode 100644
index 0000000..c78b493
--- /dev/null
+++ b/docs/SECURITY.md
@@ -0,0 +1,16 @@
+# Security Policies
+
+## Supported Versions
+
+We support updates for the following versions:
+
+| Version | Supported |
+| ------- | -------------------- |
+| 1.0.x | :material-check: |
+
+
+## Reporting a Vulnerability
+
+If you discover a security issue, please bring it to our attention right away! Please DO NOT file a public issue to report a security vulberability, instead send your report privately to [foxtechniques@gmail.com](mailto:foxtechniques@gmail.com). This will help ensure that any vulnerabilities that are found can be disclosed responsibly to any affected parties.
+
+We aim to respond to security concerns within 3 business days and will work with you to understand the issue and release a fix as soon as possible.
\ No newline at end of file
diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md
new file mode 100644
index 0000000..9dcf471
--- /dev/null
+++ b/docs/SUPPORT.md
@@ -0,0 +1,31 @@
+# Support and Help
+
+Need help getting started or using a project? Here's how.
+
+## How to get help
+
+For any usage questions that are not specific to the project itself, please ask on [Stack Overflow](https://stackoverflow.com). By doing so, you are more likely to quickly solve your problem, and you will allow anyone else with the same question to find the answer. This also allows maintainers to focus on improving the project for others.
+
+Please seek support in the following ways:
+
+1. :book: **Read the documentation and other guides** for the project to see if you can figure it out on your own. These should be located in a root `docs/` directory. If there is an example project, explore that to learn how it works to see if you can answer your question.
+
+2. :bulb: **Search for answers and ask questions on [Stack Overflow](https://stackoverflow.com).** This is the most appropriate place for debugging issues specific to your use of the project, or figuring out how to use the project in a specific way.
+
+3. :memo: As a **last resort**, you may open an issue on GitHub to ask for help. However, please clearly explain what you are trying to do, and list what you have already attempted to solve the problem. Provide code samples, but **do not** attach your entire project for someone else to debug.
+
+## What NOT to do
+
+Please **do not** do any the following:
+
+1. :x: Do not reach out to the author or contributor on Twitter (or other social media) by tweeting or sending a direct message.
+
+1. :x: Do not email the author or contributor.
+
+1. :x: Do not open duplicate issues or litter an existing issue with +1's.
+
+These are not appropriate avenues for seeking help or support with an open-source project. Please follow the guidelines in the previous section. Public questions get public answers, which benefits everyone in the community. ✌️
+
+## Customer Support
+
+Irene-sankey does not provide any sort of "customer support" for open-source projects. However, we are available for consulting.
\ No newline at end of file
diff --git a/docs/demo.md b/docs/demo.md
index 51392ec..be815d5 100644
--- a/docs/demo.md
+++ b/docs/demo.md
@@ -1,46 +1,18 @@
-### Irene-Sankey Demo
+# Demo
-Once the Irene-Sankey package is installed, you can use it in your projects. Here’s an example of how to use it:
+## Irene-Sankey Demo
-```py title="irene_sankey_demo.py" linenums="1"
-import pandas as pd
-from irene_sankey.core.traverse import traverse_sankey_flow
-from irene_sankey.plots.sankey import plot_irene_sankey_diagram
+The output of the `plot_irene_sankey_diagram` and `traverse_sankey_flow` function provides three structured components that represent the flow of data for generating a Sankey diagram. Here’s what each component looks like:
-# Sample data to test the functionality
-df = pd.DataFrame(
- {
- "country": ["NL","NL","NL","DE","DE","FR","FR","FR","US","US","US"],
- "industry": [
- "Technology","Finance","Healthcare",
- "Automotive","Engineering",
- "Technology","Agriculture","Healthcare",
- "Manufacturing","Technology","Finance"],
- "field": [
- "Software","Banking","Pharmaceuticals",
- "Car Manufacturing","Mechanical Engineering",
- "Software","Crop Science","Medical Devices",
- "Electronics","AI & Robotics","Investment Banking"],
- }
-)
-# Generate source-target pair, node map and link for Sankey diagrams
-flow_df, node_map, link = traverse_sankey_flow(df, ["", "country", "industry", "field"])
+=== "Sankey Plot"
-# Plot Sankey diagram
-fig = plot_irene_sankey_diagram(node_map, link, title = "Irene-Sankey Demo", node_config={
- "pad": 10,
- "line": dict(color="black", width=1),
- }
-)
-fig.show()
-```
+ { width=800 }
-The output of the `traverse_sankey_flow` function provides three structured components that represent the flow of data for generating a Sankey diagram. Here’s what each component looks like:
-=== "df"
+=== "input_df"
- The input dataframe `df` for this demo:
+ The input dataframe `input_df` for this demo:
| country| industry| field|
| ------- | ------------- | ---------------------- |
@@ -154,9 +126,51 @@ The output of the `traverse_sankey_flow` function provides three structured comp
```
-=== "Sankey Plot"
+## How to Use
- { width=800 }
+Once the Irene-Sankey package is installed, you can use it in your projects. Here’s the code of the demo:
+
+```py title="irene_sankey_demo.py" linenums="1"
+import pandas as pd
+from irene_sankey.core.traverse import traverse_sankey_flow
+from irene_sankey.plots.sankey import plot_irene_sankey_diagram
+
+# Sample data to test the functionality
+input_df = pd.DataFrame(
+ {
+ "country": ["NL","NL","NL","DE","DE","FR","FR","FR","US","US","US"],
+ "industry": [
+ "Technology","Finance","Healthcare",
+ "Automotive","Engineering",
+ "Technology","Agriculture","Healthcare",
+ "Manufacturing","Technology","Finance"],
+ "field": [
+ "Software","Banking","Pharmaceuticals",
+ "Car Manufacturing","Mechanical Engineering",
+ "Software","Crop Science","Medical Devices",
+ "Electronics","AI & Robotics","Investment Banking"],
+ }
+)
+
+# Generate source-target pair, node map and link for Sankey diagrams
+flow_df, node_map, link = traverse_sankey_flow(input_df, ["", "country", "industry", "field"])
+
+# Plot Sankey diagram
+fig = plot_irene_sankey_diagram(node_map, link, title = "Irene-Sankey Demo", node_config={
+ "pad": 10,
+ "line": dict(color="black", width=1),
+ }
+)
+fig.show()
+```
+!!! tip
+
+ You can use `node_map` and `link` with your own Plotly’s Sankey diagram functions.
+
+
+Thank you for exploring our demo! We hope this example has given you a clear understanding of how to utilize our package and integrate its features into your projects. Whether you're just getting started or diving deeper, our goal is to make your experience as seamless and productive as possible.
+
+Happy coding!
[Irene-Sankey]: https://pypi.org/project/irene-sankey/
[virtual environment]: https://realpython.com/what-is-pip/#using-pip-in-a-python-virtual-environment
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index 0c1e107..4698e49 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -6,7 +6,7 @@ title: Irene-Sankey Python Package
Irene-Sankey is a python package that enables the creation of customizable and informative Sankey diagrams. It is designed to be intuitive for both beginners and experts, with flexible options for styling, data input, and configuration, making it easy to represent complex flows visually.
-[](https://pypi.org/project/irene-senkey/)
+[](https://pypi.org/project/irene-sankey/)
[](https://pypi.org/project/irene-sankey/)
[](https://github.com/fox-techniques/irene-sankey/blob/main/LICENSE)
[](https://github.com/fox-techniques/irene-sankey)
diff --git a/docs/installation.md b/docs/installation.md
index 971e329..f1a3672 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -1,5 +1,6 @@
+# Installation
-### with pip recommended { #with-pip data-toc-label="with pip" }
+## with pip recommended { #with-pip data-toc-label="with pip" }
Irene-Sankey is published as a python package and can be installed with
`pip`, ideally by using a [virtual environment]. Open up a terminal and install
@@ -52,7 +53,8 @@ install those packages separately.
[semantic versioning]: https://semver.org/
[Using Python's pip to Manage Your Projects' Dependencies]: https://realpython.com/what-is-pip/
-### with git
+
+## with git
Irene-Sankey can be directly used from [GitHub] by cloning the
repository into a subfolder of your project root which might be useful if you
@@ -67,10 +69,46 @@ Next, install the theme and its dependencies with:
```
pip install -e irene-sankey
```
+
+## with poetry
+
+Prerequisites:
+
+- Python 3.8 or higher
+- [Poetry]
+
+Installing Irene-Sankey:
+
+```bash
+poetry add irene-sankey
+```
+
+This command downloads and installs the package and its dependencies and adds the package as a dependency in your `pyproject.toml`.
+
+Using the Package:
+
+After installation, you can start using the package in your project. If you need to enter the virtual environment managed by Poetry, run:
+
+```bash
+poetry shell
+```
+
+Verify the Installation:
+
+```bash
+poetry show irene-sankey
+```
+
+Updating the Package:
+
+```bash
+poetry update irene-sankey
+```
+
[Irene-Sankey]: https://pypi.org/project/irene-sankey/
[GitHub]: https://github.com/fox-techniques/irene-sankey
[numpy]: https://pypi.org/project/numpy/
[pandas]: https://pypi.org/project/pandas/
[plotly]: https://pypi.org/project/plotly/
[requests]: https://pypi.org/project/requests/
-
\ No newline at end of file
+ [Poetry]: https://python-poetry.org/docs/#installation
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index cf32ff1..b555f6e 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -32,12 +32,19 @@ nav:
- Home: index.md
- Installation: installation.md
- Demo: demo.md
- - License: license.md
+ - Support: SUPPORT.md
+ - Contributing: CONTRIBUTING.md
+ - Code of Conduct: CODE_OF_CONDUCT.md
+ - Security Policies: SECURITY.md
+ - License: LICENSE.md
+ - Credits: CREDITS.md
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/fox-techniques/irene-sankey
+ - icon: fontawesome/brands/x-twitter
+ link: https://x.com/foxtechniques/
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/fox-techniques/