Library for interacting with SharePoint
Project description
sharepoint-crud
Solution to integrate SharePoint with your Python script
Improvement
This project is under development, so if you have any suggestions, please let me know:
- Get file content
- Search for a file
- Upload file
- Edit file
- Delete a file
💻 Requeriments
Before you begin, ensure you have met the following requirements:
- you have installed a
python 3.8
or higher
🚀 Install sharepoint-crud
- run the command:
pip install sharepoint-crud
to activate the virtual environment - voilà!
☕ Run
To run sharepoint-crud, you need a sharepoint account. You can instanciate an object with the following parameters:
from sharepoint-crud import SharePointCrud
sharepoint = SharePointCrud(
'https://your-site.sharepoint.com/sites/your-library',
'your-email@your-domain.com',
'your-password'
)
Actually, is possible download and upload file. An example:
file_content = sharepoint.get_file('your/folder/to/your/file', 'your-file.file_format')
An example:
I have a file example.csv
in the folder my_library/Shared Files/my_folder
on SharePoint:
from sharepoint-crud import SharePointCrud
file_content = SharePointCrud(
'https://your-site.sharepoint.com/sites/your-library',
'your-email@your-domain.com',
'your-password'
).get_file('my_library/Shared Files/my_folder', 'example.csv')
📫 Contributing
To contribute to sharepoint-crud, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and confirm them:
git commit -m '<commit_message>'
- Send to the original branch:
git push origin <project_name> <location>
- Create the pull request.
Alternatively, consult the GitHub documentation on creating a pull request.
🤝 Colaborators
Emanuel Almeida |
📝 Licença
This project is under license. See the file LICENÇA for more details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.