Skip to content

Commit 424b19d

Browse files
Athroniaethclaude
andcommitted
docs: fix library name references from fastapi-api-key to keyshield
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent 0a15efa commit 424b19d

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

CODE_OF_CONDUCT.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# Fastapi Api Key Code of Conduct
1+
# Keyshield Code of Conduct
22

3-
Like the technical community as a whole, the Fastapi Api Key team and community is made up of a mixture of professionals and volunteers from all over the world, working on every aspect of the mission - including mentorship, teaching, and connecting people.
3+
Like the technical community as a whole, the Keyshield team and community is made up of a mixture of professionals and volunteers from all over the world, working on every aspect of the mission - including mentorship, teaching, and connecting people.
44

55
Diversity is one of our huge strengths, but it can also lead to communication issues and unhappiness. To that end, we have a few ground rules that we ask people to adhere to. This code applies equally to founders, mentors and those seeking help and guidance.
66

77
This isn’t an exhaustive list of things that you can’t do. Rather, take it in the spirit in which it’s intended - a guide to make it easier to enrich all of us and the technical communities in which we participate.
88

9-
This code of conduct applies to all spaces managed by the Fastapi Api Key project or . This includes IRC, the mailing lists, the issue tracker, DSF events, and any other forums created by the project team which the community uses for communication. In addition, violations of this code outside these spaces may affect a person's ability to participate within them.
9+
This code of conduct applies to all spaces managed by the Keyshield project or . This includes IRC, the mailing lists, the issue tracker, DSF events, and any other forums created by the project team which the community uses for communication. In addition, violations of this code outside these spaces may affect a person's ability to participate within them.
1010

1111
If you believe someone is violating the code of conduct, we ask that you report it by emailing [pierre.chaumont@hotmail.fr](mailto:pierre.chaumont@hotmail.fr). For more details please see our
1212

1313
- **Be friendly and patient.**
1414
- **Be welcoming.** We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
1515
- **Be considerate.** Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language.
16-
- **Be respectful.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the Fastapi Api Key community should be respectful when dealing with other members as well as with people outside the Fastapi Api Key community.
16+
- **Be respectful.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the Keyshield community should be respectful when dealing with other members as well as with people outside the Keyshield community.
1717
- **Be careful in the words that you choose.** We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable. This includes, but is not limited to:
1818
- Violent threats or language directed against another person.
1919
- Discriminatory jokes and language.
@@ -23,7 +23,7 @@ If you believe someone is violating the code of conduct, we ask that you report
2323
- Unwelcome sexual attention.
2424
- Advocating for, or encouraging, any of the above behavior.
2525
- Repeated harassment of others. In general, if someone asks you to stop, then stop.
26-
- **When we disagree, try to understand why.** Disagreements, both social and technical, happen all the time and Fastapi Api Key is no exception. It is important that we resolve disagreements and differing views constructively. Remember that we’re different. The strength of Fastapi Api Key comes from its varied community, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.
26+
- **When we disagree, try to understand why.** Disagreements, both social and technical, happen all the time and Keyshield is no exception. It is important that we resolve disagreements and differing views constructively. Remember that we’re different. The strength of Keyshield comes from its varied community, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.
2727

2828
Original text courtesy of the [Speak Up! project](http://web.archive.org/web/20141109123859/http://speakup.io/coc.html).
2929

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: keyshield
22
site_description: "Secure API key management for Python web frameworks"
3-
site_url: ""
3+
site_url: "https://Athroniaeth.github.io/keyshield/"
44
repo_url: https://github.com/Athroniaeth/keyshield
55
repo_name: Athroniaeth/keyshield
66
theme:

src/keyshield/__main__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from keyshield.services.base import DEFAULT_SEPARATOR, DEFAULT_GLOBAL_PREFIX
77

88

9-
app = Typer(no_args_is_help=True, help="FastAPI API Keys CLI")
9+
app = Typer(no_args_is_help=True, help="Keyshields CLI")
1010

1111

1212
@app.callback(invoke_without_command=True)
@@ -15,11 +15,11 @@ def _main(
1515
None,
1616
"--version",
1717
"-v",
18-
help="Show the FastAPI API Keys package version and exit.",
18+
help="Show the Keyshields package version and exit.",
1919
is_eager=True,
2020
),
2121
):
22-
"""FastAPI API Keys CLI"""
22+
"""Keyshields CLI"""
2323
from keyshield import __version__
2424

2525
if version:

src/keyshield/django/apps.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ class FastApiApiKeyDjangoConfig(AppConfig):
1717

1818
name = "keyshield.django"
1919
label = "keyshield_django"
20-
verbose_name = "FastAPI API Key"
20+
verbose_name = "Keyshield"
2121
default_auto_field = "django.db.models.BigAutoField"

0 commit comments

Comments
 (0)