Skip to content

Update README #1

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.

Sign up for GitHub

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

Open
shivang-b wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 28 additions & 31 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,35 @@
This library provides the ability to automate various
SharePoint activities through easy to read and modify Python
scripts.
## Overview
This library provides the ability to automate various SharePoint activities through easy to read and modify Python scripts.

The core library is located in the sp module. The scripts
module contains a number of scripts for performing specific
activities such as backing up sites.
The core library is located in the sp module. The scripts module contains a number of scripts for performing specific activities such as backing up sites.

USAGE
## Usage
```python
# Working with the sp module.

# Working with the sp module.

import sp
from sp import *

# enumerate all sites and print out the url
sp.enum_sites("http://myserver", lambda s: print s.Url)

# apply a master page to all webs
def apply_theme(web):
web.MasterUrl = "http://myserver/custom.master"
web.Update()

sp.enum_all_webs("http://myserver", apply_theme)

import sp
from sp import *

# enumerate all sites and print out the url
sp.enum_sites("http://myserver", lambda s: print s.Url)

# apply a master page to all webs
def apply_theme(web):
web.MasterUrl = "http://myserver/custom.master"
web.Update()

sp.enum_all_webs("http://myserver", apply_theme)
```

# Calling scripts in the scripts module

> cd sp.py
> ipy backupsites.py --url http://myserver --destination c:\backups --overwrite
>
> ipy setprofileprop.py --url http://myserver --property Picture --value http://myserver/pics/{Alias}.jpg
>
# Calling scripts in the scripts module

> cd sp.py
> ipy backupsites.py --url http://myserver --destination c:\backups --overwrite
>
> ipy setprofileprop.py --url http://myserver --property Picture --value http://myserver/pics/{Alias}.jpg
>

REQUIREMENTS
## Requirements

This library is designed to work with Iron Python 1.1.1. You
can download Iron Python from http://www.codeplex.com/IronPython.
This library is designed to work with Iron Python 1.1.1. You can download Iron Python from http://www.codeplex.com/IronPython.