Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramblingcookiemonster/psexcel
A simple Excel PowerShell module
https://github.com/ramblingcookiemonster/psexcel
epplus excel powershell powershell-modules reporting spreadsheet
Last synced: 10 days ago
JSON representation
A simple Excel PowerShell module
- Host: GitHub
- URL: https://github.com/ramblingcookiemonster/psexcel
- Owner: RamblingCookieMonster
- License: mit
- Created: 2015-03-28T19:05:17.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-08-31T10:47:48.000Z (about 3 years ago)
- Last Synced: 2024-10-18T16:14:10.668Z (18 days ago)
- Topics: epplus, excel, powershell, powershell-modules, reporting, spreadsheet
- Language: PowerShell
- Homepage: http://ramblingcookiemonster.github.io/PSExcel-Intro/
- Size: 1.12 MB
- Stars: 245
- Watchers: 43
- Forks: 67
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://ci.appveyor.com/project/RamblingCookieMonster/psexcel)
PSExcel
=============
**IMPORTANT:** This project is no longer maintained. Please consider Doug's excellent [ImportExcel example](https://github.com/dfinke/ImportExcel), which is frequently updated by Doug and the community.
This is a rudimentary PowerShell module for working with Excel via the [EPPlus](http://epplus.codeplex.com/) library, with no dependencies on Excel itself.
* Thanks to Doug Finke for his [ImportExcel example](https://github.com/dfinke/ImportExcel) - hadn't seen EPPlus before this!
* Thanks to Philip Thompson for his [expansive module](https://excelpslib.codeplex.com/) illustrating how to work with EPPlus in PowerShell
* Thanks to the team and contributors behind [EPPlus](http://epplus.codeplex.com/) for a fantastic solution allowing .NET Excel interaction, without Excel.
Caveats:
* This covers limited functionality; contributions to this function or additional functions would be welcome!
* Minimal testing. Contributions welcome!
* Naming conventions subject to change. Suggestions welcome!
## Functionality
* Export random PowerShell output to Excel spreadsheets
* Import Excel spreadsheets to PowerShell as objects
* No dependency on Excel being installed
## Instructions
```powershell
# One time setup
# Download the repository
# Unblock the zip
# Extract the PSExcel folder to a module path (e.g. $env:USERPROFILE\Documents\WindowsPowerShell\Modules\)
#Simple alternative, if you have PowerShell 5, or the PowerShellGet module:
Install-Module PSExcel
# Import the module.
Import-Module PSExcel #Alternatively, Import-Module \\Path\To\PSExcel
# Get commands in the module
Get-Command -Module PSExcel
# Get help for a command
Get-Help Import-XLSX -Full
# Export data to an XLSX spreadsheet
Get-ChildItem C:\ -File |
Export-XLSX -Path C:\Files.xlsx
# Import data from an XLSX spreadsheet
Import-XLSX -Path C:\Files.xlsx
```
## Examples
Several examples are available on [the accompanying blog post](http://ramblingcookiemonster.github.io/PSExcel-Intro/) and the embedded [Gist](https://gist.github.com/RamblingCookieMonster/7f49beeaebb570204581#file-zpsexcel-intro-ps1).
Some highlights:
### Export and import data
```powershell
#Create some demo data
$DemoData = 1..10 | Foreach-Object{
$EID = Get-Random -Minimum 1 -Maximum 1000
$Date = (Get-Date).adddays(-$EID)
New-Object -TypeName PSObject -Property @{
Name = "jsmith$_"
EmployeeID = $EID
Date = $Date
} | Select Name, EmployeeID, Date
}
# Export it
$DemoData | Export-XLSX -Path C:\temp\Demo.xlsx
# Import it back
$Imported = Import-XLSX -Path C:\Temp\Demo.xlsx -Header samaccountname, EID, Date
```
Verify that it exported:
Check the data we imported back:
### Fun with formatting
Freeze panes:
```powershell
# Open the previously created Excel file...
$Excel = New-Excel -Path C:\temp\Demo.xlsx
# Get a Worksheet
$Worksheet = $Excel | Get-Worksheet -Name Worksheet1
# Freeze the top row
$Worksheet | Set-FreezePane -Row 2
# Save and close!
$Excel | Close-Excel -Save
```
Format the header:
```powershell
# Re-open the file
$Excel = New-Excel -Path C:\temp\Demo.xlsx
# Add bold, size 15 formatting to the header
$Excel |
Get-WorkSheet |
Format-Cell -Header -Bold $True -Size 14
# Save and re-open the saved changes
$Excel = $Excel | Save-Excel -Passthru
```
Format the first column:
```powershell
# Text was too large! Set it to 11
$Excel |
Get-WorkSheet |
Format-Cell -Header -Size 11
$Excel |
Get-WorkSheet |
Format-Cell -StartColumn 1 -EndColumn 1 -Autofit -AutofitMinWidth -AutofitMaxWidth 7 -Color DarkRed
# Save and close
$Excel | Save-Excel -Close
```
### Create tables
Why format the columns yourself? Create a table (thanks to awiddersheim!):
```
# Add a table, autofit the data. We use force to overwrite our previous demo.
$DemoData | Export-XLSX -Path C:\Temp\Demo.xlsx -Table -Autofit -Force
```
### Pivot tables and charts
This is straight from Doug Finke's fantastic [ImportExcel module](https://github.com/dfinke/ImportExcel):
```powershell
# Fun with pivot tables and charts! Props to Doug Finke
Get-ChildItem $env:USERPROFILE -Recurse -File |
Export-XLSX -Path C:\Temp\Files.xlsx -PivotRows Extension -PivotValues Length -ChartType Pie
```
[](http://ramblingcookiemonster.github.io/images/psexcel-intro/pivot.png)
## Notes
Note that while some of these examples leverage PowerShell version 3 or later language, the module itself should work with PowerShell 2, and all Pester tests run against both PowerShell 2 and PowerShell 4.