Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Where to find documentation ? #892

Open
Exanis opened this issue Dec 27, 2022 · 1 comment
Open

Where to find documentation ? #892

Exanis opened this issue Dec 27, 2022 · 1 comment

Comments

@Exanis
Copy link

Exanis commented Dec 27, 2022

Hello,

I am trying to find working documentation for the library. So far I've tried https://pysaml2.readthedocs.io/en/latest/install.html - the installation documentation doesn't match the installation documentation in the README of the github repository (there is only instruction on how to compile the code, not on how to install using pip).

I have a very simple use case in mind : I have a metadata url from a provider (most IdP provider offer those) and I want to allow users to login to my service through this IdP.

I tried goind to https://pysaml2.readthedocs.io/en/latest/examples/sp.html and following the instruction, but since I'm using the pip version as per the README I don't have the file and the folders are all badly named.

I tried to read to source of the example, but they are visibly not meant to be read (and the documentation state as much, explaining that they are used to check if everything is installed).

I would be glad to write some documentation myself and provide a pull request to improve the project, but I can't do so without at least a working example of how the library is supposed to be used. Is the minimal working example a 1000+ line of code? Is there really no easiest way to just use a metadata url and get the user's SPN ?

Thank you

@Will-Ruddick
Copy link

I am also in the same position - struggling to create the metadata file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants