# 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:
- [x] 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 pypoint
- run the command: `pip install sharepoint-crud` to activate the virtual environment
- voilà!
## ☕ Run
To run pypoint, you need a sharepoint account. You can instanciate an object with the following parameters:
```python
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 a file from sharepoint:
```python
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:
```python
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 pypoint, follow these steps:
1. Fork this repository.
2. Create a branch: `git checkout -b <branch_name>`.
3. Make your changes and confirm them: `git commit -m '<commit_message>'`
4. Send to the original branch: `git push origin <project_name> <location>`
5. Create the pull request.
Alternatively, consult the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
## 🤝 Colaborators
<table>
<tr>
<td align="center">
<a href="https://github.com/almemanuel" title="Emanuel's GitHub">
<img src="https://avatars.githubusercontent.com/u/40006289?v=4" width="100px;" alt="Emanuel's profile photo"/><br>
<sub>
<b>Emanuel Almeida</b>
</sub>
</a>
</td>
</tr>
</table>
## 📝 Licença
This project is under license. See the file [LICENÇA](LICENSE.md) for more details.
[⬆ Turn to top](#sharepoint-crud)
<br>
Raw data
{
"_id": null,
"home_page": "https://github.com/almemanuel/sharepoint-crud",
"name": "sharepoint-crud",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "sharepoint office365",
"author": "Emanuel Almeida",
"author_email": "emanuel.almeida1998@outlook.com",
"download_url": null,
"platform": null,
"description": "# sharepoint-crud\n\n\n\n\n\n\n\n\n> Solution to integrate SharePoint with your Python script\n\n### Improvement\n\nThis project is under development, so if you have any suggestions, please let me know:\n\n- [x] Get file content\n- [ ] Search for a file\n- [ ] Upload file\n- [ ] Edit file\n- [ ] Delete a file\n\n## \ud83d\udcbb Requeriments\nBefore you begin, ensure you have met the following requirements:\n- you have installed a `python 3.8` or higher\n\n## \ud83d\ude80 Install pypoint\n- run the command: `pip install sharepoint-crud` to activate the virtual environment\n- voil\u00e0!\n\n## \u2615 Run\nTo run pypoint, you need a sharepoint account. You can instanciate an object with the following parameters:\n\n```python\nfrom sharepoint-crud import SharePointCrud\n\nsharepoint = SharePointCrud(\n 'https://your-site.sharepoint.com/sites/your-library',\n 'your-email@your-domain.com',\n 'your-password'\n)\n\n```\n\nActually, is possible download a file from sharepoint:\n\n```python\nfile_content = sharepoint.get_file('your/folder/to/your/file', 'your-file.file_format')\n\n```\nAn example:\nI have a file `example.csv` in the folder `my_library/Shared Files/my_folder` on SharePoint:\n```python\nfrom sharepoint-crud import SharePointCrud\n\nfile_content = SharePointCrud(\n 'https://your-site.sharepoint.com/sites/your-library',\n 'your-email@your-domain.com',\n 'your-password'\n).get_file('my_library/Shared Files/my_folder', 'example.csv')\n```\n\n## \ud83d\udceb Contributing\n\nTo contribute to pypoint, follow these steps:\n1. Fork this repository.\n2. Create a branch: `git checkout -b <branch_name>`.\n3. Make your changes and confirm them: `git commit -m '<commit_message>'`\n4. Send to the original branch: `git push origin <project_name> <location>`\n5. Create the pull request.\n\nAlternatively, consult the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).\n\n## \ud83e\udd1d Colaborators\n\n<table>\n <tr>\n <td align=\"center\">\n <a href=\"https://github.com/almemanuel\" title=\"Emanuel's GitHub\">\n <img src=\"https://avatars.githubusercontent.com/u/40006289?v=4\" width=\"100px;\" alt=\"Emanuel's profile photo\"/><br>\n <sub>\n <b>Emanuel Almeida</b>\n </sub>\n </a>\n </td>\n </tr>\n</table>\n\n## \ud83d\udcdd Licen\u00e7a\n\nThis project is under license. See the file [LICEN\u00c7A](LICENSE.md) for more details.\n\n[\u2b06 Turn to top](#sharepoint-crud)\n<br>\n",
"bugtrack_url": null,
"license": null,
"summary": "Library for interacting with SharePoint",
"version": "1.1",
"project_urls": {
"Homepage": "https://github.com/almemanuel/sharepoint-crud"
},
"split_keywords": [
"sharepoint",
"office365"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "04b1db193362842bdc5af234672d0d2a4ea2d1b6aa6e73485a15a7de92017d91",
"md5": "877e4f95c8806ccae25160d95fcdada8",
"sha256": "9768e095170a0bb0c18495469b470c28d82bbb87327744cdda78591263ee0e49"
},
"downloads": -1,
"filename": "sharepoint_crud-1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "877e4f95c8806ccae25160d95fcdada8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4187,
"upload_time": "2024-04-15T17:33:07",
"upload_time_iso_8601": "2024-04-15T17:33:07.945398Z",
"url": "https://files.pythonhosted.org/packages/04/b1/db193362842bdc5af234672d0d2a4ea2d1b6aa6e73485a15a7de92017d91/sharepoint_crud-1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 17:33:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "almemanuel",
"github_project": "sharepoint-crud",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sharepoint-crud"
}
JSON
